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

GATSoftwareDescription.h Go to the documentation of this file. /** @file GATSoftwareDescription.h * Header file for the GATSoftwareDescription class. * * An instance of this class is a description of a piece of software * (component) which is to be submitted as a job. It currently takes a table * describing this piece of software’s attributes to any underlying job * submission system. * * @date Wed Oct 22 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATSoftwareDescription.h,v 1.7 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) */ #if !defined(_GATSOFTWAREDESCRIPTION_H_) #define _GATSOFTWAREDESCRIPTION_H_ /* GAT Header Files */ #include "GATObject.h" #include "GATType.h" #include "GATTable.h" /* Structures, unions and enums */ /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATSoftwareDescription); #ifdef __cplusplus extern "C" { #endif /** GATSoftwareDescription_Create * @brief Create a new GATSoftwareDescription object * * The function @c GATSoftwareDescription_Create creates a new * GATSoftwareDescription object * * @param attributes The attributes to initially use while initialising the * new GATSoftwareDescription. This parameter may be ommitted (zero). * * @return Returns a handle to the newly created GATSoftwareDescription object. * Returns 0 (zero) if an error occurs. */ GATSoftwareDescription GATSoftwareDescription_Create(GATTable_const attributes); /** void GATSoftwareDescription_Destroy(GATSoftwareDescription *resource) * * The function GATSoftwareDescription_Destroy is the destructor used to * free all the memory allocated by an GATSoftwareDescription instance. * * @param description The pointer to the GATSoftwareDescription to destroy */ void GATSoftwareDescription_Destroy(GATSoftwareDescription *object); /** GATSoftwareDescription_Equals * @brief Compare two GATSoftwareDescription objects * * The function @c GATSoftwareDescription_Equals compares two objects of the * @c GATSoftwareDescription 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 GATSoftwareDescription_Equals(GATSoftwareDescription_const lhs, GATSoftwareDescription_const rhs, GATBool *isequal); /** GATSoftwareDescription_Clone * @brief Clone the given GATSoftwareDescription * * The function @c GATSoftwareDescription_Clone generates a (deep) copy of * the given GATSoftwareDescription. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATSoftwareDescription_Clone(GATSoftwareDescription_const object, GATSoftwareDescription *new_object); /** GATType GATSoftwareDescription_GetType(GATSoftwareDescription_const resource) * @brief Return the type of the GATSoftwareDescription * * The function @c GATSoftwareDescription_GetType always returns * @c #GATType_GATSoftwareDescription. * * @param object The object to inspect * * @return Returns always @c #GATType_GATSoftwareDescription. */ GATType GATSoftwareDescription_GetType(GATSoftwareDescription_const object); /** GATResult GATSoftwareDescription_GetInterface(GATSoftwareDescription_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATSoftwareDescription_GetInterface allows to get a pointer to an * additional interface supported by this GATSoftwareDescription. * * @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 GATSoftwareDescription_GetInterface(GATSoftwareDescription_const object, GATInterface iftype, void const **ifp); /* GATSoftwareDescription API */ /** GATSoftwareDescription_GetAttributes * @brief Access the stored set of attributes * * The function @c GATSoftwareDescription_getAttributes allows to access the * attributes stored insoide the given GATSoftwareDescription instance. */ GATTable_const GATSoftwareDescription_GetAttributes(GATSoftwareDescription_const object); /* Change the stored set of attributes */ GATResult GATSoftwareDescription_SetAttributes(GATSoftwareDescription object, GATTable_const attributes); /* GATAdvertiseable API */ #define GATSOFTWAREDESCRIPTION_VERSION1 0x0100 #define GATSOFTWAREDESCRIPTION_LASTVERSION GATSOFTWAREDESCRIPTION_VERSION1 #define GATSOFTWAREDESCRIPTION_MINOR_MASK 0x00ff /** GATResult GATSoftwareDescription_Serialise(GATSoftwareDescription file, GATObject stream, GATBool clear_dirty) * @brief Serialise a GATSoftwareDescription object * * The function GATSoftwareDescription_Serialise serialises the given * GATSoftwareDescription object into the given stream. * * @param object The GATSoftwareDescription 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 GATSoftwareDescription_Serialise(GATSoftwareDescription object, GATObject stream, GATBool clear_dirty); /** GATSoftwareDescription GATSoftwareDescription_DeSerialise(GATContext context, GATObject stream, GATBool clear_dirty) * @brief De-serialise a GATSoftwareDescription object * * The function GATSoftwareDescription_DeSerialise de-serialises a streamed * GATSoftwareDescription 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 GATSoftwareDescription object. */ GATSoftwareDescription GATSoftwareDescription_DeSerialise(GATContext context, GATObject stream, GATResult *result); /** GATSoftwareDescription_GetIsDirty * * The function GATSoftwareDescription_GetIsDirty retrieves the status of the * dirty flag of this GATSoftwareDescription object. * * @param object The GATSoftwareDescription object to inspect for its dirty * status. * @param isdirty The pointer to a variable, which receives the dirty status. * * @return An error code. */ GATResult GATSoftwareDescription_GetIsDirty(GATSoftwareDescription_const object, GATBool *isdirty); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATSOFTWAREDESCRIPTION_H_) */