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

GATMetricEvent.h Go to the documentation of this file. /** @file GATMetricEvent.h * Header file for the GATMetricEvent class. * * A GATMetricEvent represents an event indicating the measurement of a metric * and the associated resultant data. * * @date Wed Sep 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATMetricEvent.h,v 1.13 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 _GATMETRICEVENT_H_ #define _GATMETRICEVENT_H_ 1 #include "GATObject.h" #include "GATMetric.h" #include "GATTime.h" #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATMetricEvent); /** GATMetricEvent_Create_Continuous * @brief Create a new GATMetricEvent object * * The function @c GATMetricEvent_Create_Continuous creates a new * GATMetricEvent object. * * @param source The event source for this GATMetricEvent. * @param metric The associated metric. * @param callback The function to call to get at the current metric value. * @param data Data to be passed through to the callback function. * * @return Returns a handle to the newly created GATMetricEvent object. * Returns 0 (zero) if an error occurs. */ GATMetricEvent GATMetricEvent_Create_Continuous(GATObject_const source, GATMetric metric, GATMetricEvent_GetValueProc callback, void *data); /** GATMetricEvent_Create_EventLike * @brief Create a new GATMetricEvent object * * The function @c GATMetricEvent_Create_EventLike creates a new * GATMetricEvent object. * * @param source The event source for this GATMetricEvent. * @param metric The associated metric. * @param buffer The buffer containing the metric value. * @param size The size of the buffer. * * @return Returns a handle to the newly created GATMetricEvent object. * Returns 0 (zero) if an error occurs. */ GATMetricEvent GATMetricEvent_Create_EventLike(GATObject_const source, GATMetric metric, void *buffer, GATuint32 size); /** void GATMetricEvent_Destroy(GATMetricEvent *resource) * * The function GATMetricEvent_Destroy is the destructor used to * free all the memory allocated by an GATMetricEvent instance. * * @param description The pointer to the GATMetricEvent to destroy */ void GATMetricEvent_Destroy(GATMetricEvent *object); /** GATMetricEvent_Equals * @brief Compare two GATMetricEvent objects * * The function @c GATMetricEvent_Equals compares two objects of the * @c GATMetricEvent 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 GATMetricEvent_Equals(GATMetricEvent_const lhs, GATMetricEvent_const rhs, GATBool *isequal); /** GATMetricEvent_Clone * @brief Clone the given GATMetricEvent * * The function @c GATMetricEvent_Clone generates a (deep) copy of * the given GATMetricEvent. * * @param description The object to clone * @param new_object The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATMetricEvent_Clone(GATMetricEvent_const object, GATMetricEvent *new_object); /** GATType GATMetricEvent_GetType(GATMetricEvent_const resource) * @brief Return the type of the GATMetricEvent * * The function @c GATMetricEvent_GetType always returns * @c #GATType_GATMetricEvent. * * @param object The object to inspect * * @return Returns always @c #GATType_GATMetricEvent. */ GATType GATMetricEvent_GetType(GATMetricEvent_const object); /** int GATMetricEvent_GetInterface(GATMetricEvent_const file, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATObject * * The function GATMetricEvent_GetInterface allows to get a pointer to an * additional interface supported by this GATMetricEvent. * * @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 GATMetricEvent_GetInterface(GATMetricEvent_const file, GATInterface iftype, void const **ifp); /** GATMetricEvent_GetSource * * The function GATMetricEvent_GetSource returns an instance of the source * of this GATMetricEvent. * * @param metric_event The metric_event to query for its source. * * @return The event source. */ GATObject_const GATMetricEvent_GetSource(GATMetricEvent_const metric_event); /** GATMetricEvent_GetValueType * * The function GATMetricEvent_GetValueType returns the value type * corresponding to this GATMetricEvent. * * @param metric_event The metric_event to query for its associated metric. * * @return The type of the associated value. */ GATType GATMetricEvent_GetValueType(GATMetricEvent_const metric_event); /** GATMetricEvent_GetValue * * The function GATMetricEvent_GetValue returns the value corresponding to * this GATMetricEvent. * * @param metric_event The metric_event to query for its associated metric. * @param buffer The buffer, where the retrieved value should be returned to. * @param size The size of the buffer. * * @return An error code. * * @remark The value will be returned in a variable, which has the type * specified while creating the GATMetric associated with this value. * The provided buffer should be large enough to hold an instance of * this data type. */ GATResult GATMetricEvent_GetValue(GATMetricEvent_const metric_event, void *buffer, GATuint32 size); /** GATMetricEvent_GetMetric * * The function GATMetricEvent_GetMetric * * @param metric_event The metric_event to query for its associated metric. * * @return The associated metric instance. */ GATMetric_const GATMetricEvent_GetMetric(GATMetricEvent_const metric_event); /** GATMetricEvent_GetEventTime * * The function GATMetricEvent_GetEventTime * * @param metric_event The metric_event to query for the time it happened. * * @return The time, the event happened. */ GATTime_const GATMetricEvent_GetEventTime(GATMetricEvent metric_event); #ifdef __cplusplus } #endif #endif /* _GATMETRICEVENT_H_ */