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

GATObject.h Go to the documentation of this file. /** @file GATObject.h * Header file for the GATObject class. * * A GATObject can represent any GAT Object. * This file contains mostly declarations of generic implementations for the * different interfaces used throughout the GAT engine. * * @date Wed Sep 24 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATObject.h,v 1.25 2004/03/24 19:30:58 hartmutkaiser Exp $ * * Copyright (C) Tom Goodale * This file is part of the GAT Engine. * Contributed by Tom Goodale <goodale@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 _GATOBJECT_H_ #define _GATOBJECT_H_ 1 #include "GATType.h" /* macros */ /* * Conversion helper functions for every GAT object. The corresponding * *_DEFINE macros are located inside the GATInternal.h file, because these * are not meant for public consumtion. * */ #define GATOBJECT_DECLARE_CONVERTERS_QUALIFIED_EX(qualifier, type, base) \ qualifier type base ## _To ## type(base object); \ qualifier base type ## _To ## base(type derived); \ qualifier type ## _const base ## _To ## type ## _const( \ base ## _const object); \ qualifier base ## _const type ## _To ## base ## _const( \ type ## _const derived) \ /**/ #define GATOBJECT_DECLARE_CONVERTERS_QUALIFIED(qualifier, type) \ GATOBJECT_DECLARE_CONVERTERS_QUALIFIED_EX(qualifier, type, GATObject) \ /**/ #define GATOBJECT_DECLARE_CONVERTERS(type) \ GATOBJECT_DECLARE_CONVERTERS_QUALIFIED(extern, type) \ /**/ /* Conversion helper functions for every GAT object */ #define GATOBJECT_DEFINE_CONVERTERS_QUALIFIED_EX( \ qualifier, type, gattype, base) \ \ qualifier type base ## _To ## type(base object) \ { \ return (gattype == GATObject_GetType(base ## _ToGATObject(object))) ? \ (type)object : 0; \ } \ \ qualifier base type ## _To ## base(type derived) \ { \ return (base) derived; \ } \ \ qualifier type ## _const base ## _To ## type ## _const( \ base ## _const object) \ { \ return (gattype == GATObject_GetType(base ## _ToGATObject_const(object))) ? \ (type ## _const) object : 0; \ } \ \ qualifier base ## _const type ## _To ## base ## _const( \ type ## _const derived) \ { \ return (base ## _const) derived; \ } \ /**/ #define GATOBJECT_DEFINE_CONVERTERS_QUALIFIED(qualifier, type, gattype) \ GATOBJECT_DEFINE_CONVERTERS_QUALIFIED_EX( \ qualifier, type, gattype, GATObject) \ /**/ #define GATOBJECT_DEFINE_CONVERTERS(type) \ GATOBJECT_DEFINE_CONVERTERS_QUALIFIED(extern, type, GATType_ ## type) \ /**/ #ifdef __cplusplus extern "C" { #endif /* genericity support for all GAT objects */ /** GATType GATObject_GetType(GATObject const object) * @brief Get the type from a GATObject * * The function GATObject_GetType implements a generic way to return the * actual type of a given GATObject. * * @param object The GATObject, for which its type has to be returned * * @return The @c #GATType of the object under inspection */ GATType GATObject_GetType(GATObject_const object); /** void GATObject_Destroy(GATObject *object) * @brief Destroy a GATObject * * The function GATObject_Destroy implements a generic way to destroy an * arbitrary GATObject. * * @param object The GATObject, which has to be destroyed. */ void GATObject_Destroy(GATObject *object); /** int GATObject_Equals(GATObject const lhs, GATObject const rhs, GATBool *isequal) * @brief Compare to GATObject's * * The function GATObject_Equals allows to compare generically two arbitrary * GATObject's. * * @param lhs The first GATObject to compare. * @param rhs The second GATObject to compare. * @param isequal The pointer, through which the result is to be returned. * * @result An error code. */ GATResult GATObject_Equals(GATObject_const lhs, GATObject_const rhs, GATBool *isequal); /** int GATObject_Clone(GATObject const object, GATObject *new_object) * @brief Clone a GATObject * * The function GATObject_Clone allows to get a exact copy of an arbitrary * GATObject. If the object to copy is a container object (i.e. GATTable, * GATList or similar), all the contained therein elements are copied too. * * @param object The object to be copied. * @param new_object The pointer, through which the result is to be returned. * * @return An error type. */ GATResult GATObject_Clone(GATObject_const object, GATObject *result); /** int GATObject_GetInterface(GATObject_const object, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATObject_GetInterface allows to get a pointer to an * additional interface supported by this GATObject. * * @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 GATObject_GetInterface(GATObject_const object, GATInterface iftype, void const **ifp); GATResult GATObject_GetCPIInstanceData(GATObject object, void **data); /* Helper functions needed for proper generic type conversion */ GATObject GATObject_ToGATObject(GATObject object); GATObject_const GATObject_ToGATObject_const(GATObject_const object); /* generic serialisation support for GATObject's */ GATResult GATSerialisable_Serialise(GATObject object, GATObject stream, GATBool clear_dirty); GATObject GATSerialisable_DeSerialise(GATContext context, GATObject stream, GATResult *result); GATResult GATSerialisable_GetIsDirty(GATObject_const object, GATBool *isdirty); /* generic streaming support for GATObject's */ GATResult GATStreamable_Read(GATObject object, void *buffer, GATuint32 size, GATuint32 *read_bytes); GATResult GATStreamable_Write(GATObject object, void const *buffer, GATuint32 size, GATuint32 *written_bytes); GATResult GATStreamable_Seek(GATObject object, GATOrigin origin, GATint32 offset, GATuint32 *new_position); /* generic GATMonitorable interface */ GATResult GATMonitorable_AddMetricListener(GATObject object, GATMetricListener listener, void *listener_data, GATMetric metric, GATuint32 *cookie); GATResult GATMonitorable_RegisterPolling(GATObject object, GATMetric metric, GATMetricEvent *event, GATuint32 *cookie); GATResult GATMonitorable_RemoveRegisteredMetric(GATObject object, GATMetric metric, GATuint32 cookie); struct GATList_GATMetric_handle; /* forward declaration only */ GATResult GATMonitorable_GetMetrics(GATObject_const object, struct GATList_GATMetric_handle **metrics); /* generic GATResource access support */ GATResult GATResource_GetResourceDescription(GATObject_const object, GATResourceDescription_const *description); GATResult GATResource_GetReservation(GATObject_const object, GATReservation_const *reservation); /* Serialize primitive data items */ GATResult GATuint32_Serialise(GATuint32 data, GATObject stream); GATResult GATuint32_DeSerialise(GATObject stream, GATuint32 *data); #ifdef __cplusplus } #endif #endif /* _GATOBJECT_H_ */