Grid Application Toolkit A simple API for Grid Applications

Menu Home API-Specification API-Overview Status C Reference Manual Download Java Java-Reference General GridLab - WP-1 Links

GATResourceDescription.h Go to the documentation of this file. /** @file template.h * Source file for the implementation of the different resourceDescription * classes * * GATSoftwareResourceDescription and GATHardwareResourceDescription are to * used to describe software and hardware resources are used to specify and * find resources, which may then be used, for instance, to submit a GATJob. * * @date Wed Oct 8 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATResourceDescription.h,v 1.14 2004/03/24 19:30:58 hartmutkaiser Exp $ * * Copyright (C) Hartmut Kaiser * This file is part of the GAT Engine. * Contributed by Hartmut Kaiser <hartmutkaiser [at] t-online [dot] de>. * * Use, modification and distribution is subject to the Gridlab Software * License. (See accompanying file GLlicense.txt or copy at * http://www.gridlab.org/GLlicense.txt) */ #ifndef _RESOURCEDESCRIPTION_H_ #define _RESOURCEDESCRIPTION_H_ 1 /* GAT Header Files */ #include "GATObject.h" #include "GATType.h" #include "GATTable.h" #include "GATList.h" /* Structures, unions and enums */ /* * Declare the type specific interface functions for the * GATList_GATResourceDescription list */ GATLIST_DECLARE_QUALIFIED(extern, GATResourceDescription, GATList_GATResourceDescription); /* Macros */ #define GATRESOURCEDESCRIPTION_PROTOTYPE(type) \ typedef struct GAT ## type ## ResourceDescription_S \ *GAT ## type ## ResourceDescription; \ typedef struct GAT ## type ## ResourceDescription_S const \ *GAT ## type ## ResourceDescription_const; \ \ GATOBJECT_DECLARE_CONVERTERS(GAT ## type ## ResourceDescription); \ GATOBJECT_DECLARE_CONVERTERS_QUALIFIED_EX(extern, \ GAT ## type ## ResourceDescription, GATResourceDescription); \ \ GAT ## type ## ResourceDescription \ GAT ## type ## ResourceDescription_Create(GATTable requirements); \ \ GATResult GAT ## type ## ResourceDescription_Equals( \ GAT ## type ## ResourceDescription_const lhs, \ GAT ## type ## ResourceDescription_const rhs, GATBool *isequal); \ \ void GAT ## type ## ResourceDescription_Destroy( \ GAT## type ## ResourceDescription *resource); \ \ GATType GAT ## type ## ResourceDescription_GetType( \ GAT ## type ## ResourceDescription_const resource); \ \ GATResult GAT ## type ## ResourceDescription_Clone( \ GAT ## type ## ResourceDescription_const resource, \ GAT ## type ## ResourceDescription *new_resource); \ \ GATResult GAT ## type ## ResourceDescription_GetInterface( \ GAT ## type ## ResourceDescription_const object, GATInterface iftype, \ void const **ifp); \ \ GATResult GAT ## type ## ResourceDescription_SetDescription( \ GAT ## type ## ResourceDescription resource, GATTable requirements); \ \ GATTable_const GAT ## type ## ResourceDescription_GetDescription( \ GAT ## type ## ResourceDescription_const resource); \ \ GATResult GAT ## type ## ResourceDescription_AddResourceAttribute_GATObject(\ GAT ## type ## ResourceDescription resource, char const *name, \ GATObject_const value); \ \ GATResult GAT ## type ## ResourceDescription_AddResourceAttribute_String( \ GAT ## type ## ResourceDescription resource, char const *name, \ char const *value); \ \ GATResult GAT ## type ## ResourceDescription_AddResourceAttribute_int( \ GAT ## type ## ResourceDescription resource, char const *name, \ int value); \ \ GATResult GAT ## type ## ResourceDescription_AddResourceAttribute_short( \ GAT ## type ## ResourceDescription resource, char const *name, \ short value); \ \ GATResult GAT ## type ## ResourceDescription_AddResourceAttribute_double( \ GAT ## type ## ResourceDescription resource, char const *name, \ double value); \ \ GATResult GAT ## type ## ResourceDescription_AddResourceAttribute_float( \ GAT ## type ## ResourceDescription resource, char const *name, \ float value); \ \ GATResult GAT ## type ## ResourceDescription_RemoveResourceAttribute( \ GAT ## type ## ResourceDescription resource, char const *name); \ \ GATList_GATResourceDescription_const \ GAT ## type ## ResourceDescription_GetResourceDescriptions( \ GAT ## type ## ResourceDescription_const resource); \ \ GATResult GAT ## type ## ResourceDescription_SetResourceDescriptions( \ GAT ## type ## ResourceDescription resource, \ GATList_GATResourceDescription_const resources); \ \ GATResult GAT ## type ## ResourceDescription_AddResourceDescription( \ GAT ## type ## ResourceDescription resource, \ GATResourceDescription to_add); \ \ GATResult GAT ## type ## ResourceDescription_RemoveResourceDescription( \ GAT ## type ## ResourceDescription resource, \ GATResourceDescription to_remove); \ \ GATResult GAT ## type ## ResourceDescription_Serialise( \ GAT ## type ## ResourceDescription object, GATObject stream, \ GATBool clear_dirty); \ \ GAT ## type ## ResourceDescription \ GAT ## type ## ResourceDescription_DeSerialise( \ GATContext context, GATObject stream, GATResult *result); \ \ GATResult GAT ## type ## ResourceDescription_GetIsDirty( \ GAT ## type ## ResourceDescription_const object, GATBool *isdirty) \ /**/ #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATResourceDescription); /** void GATResourceDescription_Destroy(GATResourceDescription *resource) * * The function GATResourceDescription_Destroy is the destructor used to * free all the memory allocated by an GATResourceDescription instance. * * @param description The pointer to the GATResourceDescription to destroy */ void GATResourceDescription_Destroy(GATResourceDescription *resource); /** GATType GATResourceDescription_GetType(GATResourceDescription_const resource) * @brief Return the type of the GATResourceDescription * * The function @c GATResourceDescription_GetType always returns * @c #GATType_GATResourceDescription. * * @param object The object to inspect * * @return Returns always @c #GATType_GATResourceDescription. */ GATType GATResourceDescription_GetType(GATResourceDescription_const resource); /** GATResourceDescription_Clone * @brief Clone the given GATResourceDescription * * The function @c GATResourceDescription_Clone generates a (deep) copy of * the given GATResourceDescription. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATResourceDescription_Clone(GATType type, GATResourceDescription_const resource, GATResourceDescription *new_object); /** GATResourceDescription_Equals * @brief Compare two GATResourceDescription objects * * The function @c GATResourceDescription_Equals compares two objects of the * @c GATResourceDescription type. * * @param lhs The first list to compare * @param rhs The second list to compare * @param isequal The pointer to the location, where the outcome of the * function has to be stored. * * @return An error code. */ GATResult GATResourceDescription_Equals(GATResourceDescription_const resource, GATResourceDescription_const comparewith, GATBool *isequal); /** GATResult GATResourceDescription_GetInterface(GATResourceDescription_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATResourceDescription_GetInterface allows to get a pointer to an * additional interface supported by this GATResourceDescription. * * @param object The object to be asked for the new interface. * @param iftype The interface the object is to be asked for. * @param ifp The pointer, through which the result is to be returned. * * @return An error type. */ GATResult GATResourceDescription_GetInterface(GATResourceDescription_const object, GATInterface iftype, void const **ifp); /* GATAdvertiseable API */ #define GATRESOURCEDESCRIPTION_VERSION1 0x0100 #define GATRESOURCEDESCRIPTION_LASTVERSION GATRESOURCEDESCRIPTION_VERSION1 #define GATRESOURCEDESCRIPTION_MINOR_MASK 0x00ff /** GATResult GATResourceDescription_Serialise(GATResourceDescription file, GATObject stream, GATBool clear_dirty) * @brief Serialise a GATResourceDescription object * * The function GATResourceDescription_Serialise serialises the given GATFIle * object into the given stream. * * @param object The GATResourceDescription object to serialise. * @param stream The stream interface to use for the serialisation. * @param clear_dirty If the clear_dirty parameter is set to GATTrue, the * internal dirty flag of this object is to be reset (no used here) * * @return An error code. */ GATResult GATResourceDescription_Serialise(GATResourceDescription object, GATObject stream, GATBool clear_dirty); /** GATResourceDescription GATResourceDescription_DeSerialise(GATContext context, GATObject stream, GATBool clear_dirty) * @brief De-serialise a GATResourceDescription object * * The function GATResourceDescription_DeSerialise de-serialises a streamed * GATResourceDescription object from the given stream It constructs a new * instance of the de-serialised object. * * @param context The GAT context to be used for object construction. * @param stream The stream interface to use for the serialisation. * @param result The pointer to a variable, which receives the status code of * the operation. * * @return The newly constructed GATResourceDescription object. */ GATResourceDescription GATResourceDescription_DeSerialise(GATContext context, GATObject stream, GATResult *result); /** GATResourceDescription_GetIsDirty * * The function GATResourceDescription_GetIsDirty retrieves the status of the * dirty flag of this GATResourceDescription object. * * @param object The GATResourceDescription object to inspect for its dirty status. * @param isdirty The pointer to a variable, which receives the dirty status. * * @return An error code. */ GATResult GATResourceDescription_GetIsDirty(GATResourceDescription_const object, GATBool *isdirty); /* declare the type specific API functions for */ GATRESOURCEDESCRIPTION_PROTOTYPE(Software); /* GATSoftwareResourceDescription */ GATRESOURCEDESCRIPTION_PROTOTYPE(Hardware); /* GATHardwareResourceDescription */ #ifdef __cplusplus } /* extern "C" */ #endif #undef GATRESOURCEDESCRIPTION_PROTOTYPE #endif /* _RESOURCEDESCRIPTION_H_ */