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

GATJobDescription.h Go to the documentation of this file. /** @file GATJobDescription.h * Header file for the GATJobDescription class. * * An instance of this class describes a job to be run. * * @date Thu Oct 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATJobDescription.h,v 1.8 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(_GATJOBDESCRIPTION_H_) #define _GATJOBDESCRIPTION_H_ /* GAT Header Files */ #include "GATObject.h" #include "GATType.h" #include "GATSoftwareDescription.h" #include "GATResourceDescription.h" /* Structures, unions and enums */ #include "GATContext.h" #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATJobDescription); /** GATJobDescription_Create * @brief Create a new GATJobDescription object * * The function @c GATJobDescription_Create creates a new * GATJobDescription object * * @param context The GAT context to use while thie initialisation of the * new object. * @param software The software description of the job to describe. * @param resource The resource description for the job to describe. * * @return Returns a handle to the newly created GATJobDescription object. * Returns 0 (zero) if an error occurs. */ GATJobDescription GATJobDescription_Create_Description(GATContext context, GATSoftwareDescription_const software, GATResourceDescription_const resource); /** GATJobDescription_Create * @brief Create a new GATJobDescription object * * The function @c GATJobDescription_Create creates a new * GATJobDescription object * * @param context The GAT context to use while thie initialisation of the * new object. * @param software The software description of the job to describe. * @param resource The resource for the job to describe. * * @return Returns a handle to the newly created GATJobDescription object. * Returns 0 (zero) if an error occurs. */ GATJobDescription GATJobDescription_Create(GATContext context, GATSoftwareDescription_const software, GATResource_const resource); /** void GATJobDescription_Destroy(GATJobDescription *resource) * * The function GATJobDescription_Destroy is the destructor used to * free all the memory allocated by an GATJobDescription instance. * * @param object The pointer to the GATJobDescription to destroy */ void GATJobDescription_Destroy(GATJobDescription *object); /** GATJobDescription_Equals * @brief Compare two GATJobDescription objects * * The function @c GATJobDescription_Equals compares two objects of the * @c GATJobDescription 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 GATJobDescription_Equals(GATJobDescription_const lhs, GATJobDescription_const rhs, GATBool *isequal); /** GATJobDescription_Clone * @brief Clone the given GATJobDescription * * The function @c GATJobDescription_Clone generates a (deep) copy of * the given GATJobDescription. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATJobDescription_Clone(GATJobDescription_const object, GATJobDescription *new_object); /** GATType GATJobDescription_GetType(GATJobDescription_const resource) * @brief Return the type of the GATJobDescription * * The function @c GATJobDescription_GetType always returns * @c #GATType_GATJobDescription. * * @param object The object to inspect * * @return Returns always @c #GATType_GATJobDescription. */ GATType GATJobDescription_GetType(GATJobDescription_const object); /** GATResult GATJobDescription_GetInterface(GATJobDescription_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATJobDescription_GetInterface allows to get a pointer to an * additional interface supported by this GATJobDescription. * * @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 GATJobDescription_GetInterface(GATJobDescription_const object, GATInterface iftype, void const **ifp); /* JobDescription API */ /* Return the software description describing this job */ GATSoftwareDescription_const GATJobDescription_GetSoftwareDescription(GATJobDescription_const object); /* Return the of the resources the job can be run on */ GATResourceDescription_const GATJobDescription_GetResourceDescription(GATJobDescription_const object); /* Return the resource the job SHOULD be run on */ GATResource_const GATJobDescription_GetResource(GATJobDescription_const object); /* Serialisation API */ #define GATJOBDESCRIPTION_VERSION1 0x0100 #define GATJOBDESCRIPTION_LASTVERSION GATJOBDESCRIPTION_VERSION1 #define GATJOBDESCRIPTION_MINOR_MASK 0x00ff /** GATResult GATJobDescription_Serialise(GATJobDescription file, GATObject stream, GATBool clear_dirty) * @brief Serialise a GATJobDescription object * * The function GATJobDescription_Serialise serialises the given * GATJobDescription object into the given stream. * * @param object The GATJobDescription 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 GATJobDescription_Serialise(GATJobDescription object, GATObject stream, GATBool clear_dirty); /** GATJobDescription GATJobDescription_DeSerialise(GATContext context, GATObject stream, GATBool clear_dirty) * @brief De-serialise a GATJobDescription object * * The function GATJobDescription_DeSerialise de-serialises a streamed * GATJobDescription 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 GATJobDescription object. */ GATJobDescription GATJobDescription_DeSerialise(GATContext context, GATObject stream, GATResult *result); /** GATJobDescription_GetIsDirty * * The function GATJobDescription_GetIsDirty retrieves the status of the dirty * flag of this GATJobDescription object. * * @param object The GATJobDescription object to inspect for its dirty status. * @param isdirty The pointer to a variable, which receives the dirty status. * * @return An error code. */ GATResult GATJobDescription_GetIsDirty(GATJobDescription_const object, GATBool *isdirty); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATJOBDESCRIPTION_H_) */