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

GATTimePeriod.h Go to the documentation of this file. /** @file GATTimePeriod.h * Header file for the GATTimePeriod class. * * An instance of this class represents a time duration, a length * of time with uncertain start point. * * @date $Date: 2004/03/24 19:30:58 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATTimePeriod.h,v 1.14 2004/03/24 19:30:58 hartmutkaiser Exp $ * * Copyright (C) Kelly Davis * This file is part of the GAT Engine. * Contributed by Kelly Davis <kdavis@aei.mpg.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 _GATTIMEPERIOD_H_ #define _GATTIMEPERIOD_H_ 1 #include "GATType.h" #include "GATInternal.h" #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATTimePeriod); /** GATTimePeriod_Create * @brief Create a new GATTimePeriod object * * The function @c GATTimePeriod_Create constructs a GATTimePeriod instance * corresponding to the passed duration. * * @param duration Number of seconds this period of time lasts. * * @return Returns a handle to the newly created GATTimePeriod object. * Returns 0 (zero) if an error occurs. */ GATTimePeriod GATTimePeriod_Create(GATdouble64 duration); /** GATTimePeriod_Create_Difference * @brief Create a new GATTimePeriod object * * The function @c GATTimePeriod_Create_Difference constructs a GATTimePeriod * instance corresponding to the passed start end ending times. * * @param start The start time to calculate the time period. * @param end The end time to calculate the time period. * * @return Returns a handle to the newly created GATTimePeriod object. * Returns 0 (zero) if an error occurs. */ GATTimePeriod GATTimePeriod_Create_Difference(GATTime start, GATTime end); /** GATType GATTimePeriod_GetType(GATTimePeriod_const resource) * @brief Return the type of the GATTimePeriod * * The function @c GATTimePeriod_GetType always returns * @c #GATType_GATTimePeriod. * * @param object The object to inspect * * @return Returns always @c #GATType_GATTimePeriod. */ GATType GATTimePeriod_GetType(GATTimePeriod_const period); /** GATTimePeriod_Clone * @brief Clone the given GATTimePeriod * * The function @c GATTimePeriod_Clone generates a (deep) copy of * the given GATTimePeriod. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATTimePeriod_Clone(GATTimePeriod_const period, GATTimePeriod *thisClone); /** GATTimePeriod_Equals * @brief Compare two GATTimePeriod objects * * The function @c GATTimePeriod_Equals compares two objects of the * @c GATTimePeriod 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 GATTimePeriod_Equals(GATTimePeriod_const period, GATTimePeriod_const that, GATBool *isequal); /** void GATTimePeriod_Destroy(GATTimePeriod *resource) * * The function GATTimePeriod_Destroy is the destructor used to * free all the memory allocated by an GATTimePeriod instance. * * @param object The pointer to the GATTimePeriod to destroy */ void GATTimePeriod_Destroy(GATTimePeriod *period); /** GATResult GATTimePeriod_GetInterface(GATTimePeriod_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATTimePeriod_GetInterface allows to get a pointer to an * additional interface supported by this GATTimePeriod. * * @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 GATTimePeriod_GetInterface(GATTimePeriod_const object, GATInterface iftype, void const **ifp); /* GATAdvertiseable API */ #define GATTIMEPERIOD_VERSION1 0x0100 #define GATTIMEPERIOD_LASTVERSION GATTIMEPERIOD_VERSION1 #define GATTIMEPERIOD_MINOR_MASK 0x00ff /** GATResult GATTimePeriod_Serialise(GATTimePeriod file, GATObject stream, GATBool clear_dirty) * @brief Serialise a GATTimePeriod object * * The function GATTimePeriod_Serialise serialises the given GATTimePeriod object into the * given stream. * * @param object The GATTimePeriod 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 GATTimePeriod_Serialise(GATTimePeriod object, GATObject stream, GATBool clear_dirty); /** GATTimePeriod GATTimePeriod_DeSerialise(GATContext context, GATObject stream, GATBool clear_dirty) * @brief De-serialise a GATTimePeriod object * * The function GATTimePeriod_DeSerialise de-serialises a streamed GATTimePeriod 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 GATTimePeriod object. */ GATTimePeriod GATTimePeriod_DeSerialise(GATContext context, GATObject stream, GATResult *result); /** GATTimePeriod_GetIsDirty * * The function GATTimePeriod_GetIsDirty retrieves the status of the dirty flag of * this GATTimePeriod object. * * @param object The GATTimePeriod object to inspect for its dirty status. * @param isdirty The pointer to a variable, which receives the dirty status. * * @return An error code. */ GATResult GATTimePeriod_GetIsDirty(GATTimePeriod_const object, GATBool *isdirty); /* GATTimePeriod API functions */ /** * This operation returns the number of seconds this time * period lasts. * * @param this The GATTimePeriod to query * @return Number of seconds this time period lasts */ GATdouble64 GATTimePeriod_GetDuration(GATTimePeriod_const period); #ifdef __cplusplus } #endif #endif /* _GATTIMEPERIOD_H_ */