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

GATMetric.h Go to the documentation of this file. /** @file GATMetric.h * Header file for the GATMetric class. * * A GATMetric represents a measurable quantity within a monitoring system. * * @date Wed Sep 23 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATMetric.h,v 1.15 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 _GATMETRIC_H_ #define _GATMETRIC_H_ 1 /* GAT Header Files */ #include "GATObject.h" #include "GATType.h" #include "GATMonitorable.h" /* typedefs */ /* data types used to initialise a GATMetric from static data */ typedef struct GATStaticParameter_S { char const *key; /* name of this parameter */ GATType type; /* type of this parameter */ union { /* parameter data */ GATint16 int16_data; GATint32 int32_data; GATdouble64 double_data; GATfloat32 float_data; char const *string_data; } d; } GATStaticParameter; typedef struct GATStaticMetric_S { char const *name; GATMeasurementType measurement_type; /* metric measurement type */ GATType data_type; /* metric data type */ char const *unit; /* metric unit */ GATuint32 parameter_count; /* count of parameters */ GATStaticParameter *parameters; /* metric parameters */ } GATStaticMetric; #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATMetric); /** GATMetric_Create * @brief Create a new GATMetric object. * * The function @c GATMetric_Create creates a new GATMetric object. * * @return Returns a handle to the newly created GATMetric object. * Returns 0 (zero) if an error occurs. * * @remark This is an internal function, do not use it directly. */ GATMetric GATMetric_Create(char const *name, GATTable parameters, GATMeasurementType type, GATType datatype, char const *unit); /** int GATMetric_GetType(GATMetric_const file) * @brief Return the type of the GATMetric * * The function @c GATMetric_GetType always returns GATType_GATMetric. * * @param object The object to inspect * * @return returns always @c #GATType_GATMetric. */ GATType GATMetric_GetType(GATMetric_const table); /** GATMetric_Destroy * The GATMetric destructor. * This is the destructor for GATMetric objects. * * @param this An old GATMetric */ void GATMetric_Destroy(GATMetric *metric); /** int GATMetric_Equals(GATMetric_const lhs, GATMetric_const rhs, GATBool *isequal) * @brief Compares two GATMetric objects * * The function @c GATMetric_Equals compares two file objects of type * @c #GATMetric. * * @param lhs The first file object to compare * @param rhs The second file object to compare * @param isequal The pointer to the GATBool variable, which should receive * the result if the comparison * * @return An error code. */ GATResult GATMetric_Equals(GATMetric_const lhs, GATMetric_const rhs, GATBool *isequal); /** int GATMetric_Clone(GATMetric_const filehandle, GATMetric *new_file) * @brief Clone the given GATMetric * * The function @c GATMetric_Clone generates a (deep) copy of the given * GATMetric. * * @param filehandle The object to clone * @param new_file The pointer, through which the result is to be * returned. * * @return An error type. */ GATResult GATMetric_Clone(GATMetric_const metric, GATMetric *new_table); /** int GATMetric_GetInterface(GATMetric_const table, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATList * * The function GATMetric_GetInterface allows to get a pointer to an * additional interface supported by this GATList. * * @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 GATMetric_GetInterface(GATMetric_const table, GATInterface iftype, void const **ifp); /* GATMetric API functions */ /** GATMetric_GetName * * The function GATMetric_GetName gets the name associated with this * GATMetric. * * @param metric The metric to ask for its name. * * @return The name associated with this metric. */ char const * GATMetric_GetName(GATMetric_const metric); /** GATMetric_GetUnit * * The function GATMetric_GetUnit gets the measurement unit * associated with this GATMetric. * * @param metric The metric to ask for its measurement unit. * * @return The unit associated with this metric. */ char const * GATMetric_GetUnit(GATMetric_const metric); /** GATMetric_GetValueType * * The function GATMetric_GetValueType gets the data type of the value * provided by this GATMetric. * * @param metric The metric to ask for its data value type. * * @return The data value type associated with this metric. */ GATType GATMetric_GetValueType(GATMetric_const metric); /** GATMetric_GetParameters * * The function GATMetric_GetParameters gets the GATMetric parameter * value associated with the passed GATMetric parameter name. Ther is returned * a 0 (zero) if there is no GATMetric parameter value with the passed name. * * @param metric The metric to ask for its name. * @param table The pointer to a variable, which receives the returned * parameter table. * * @return An error code. */ GATResult GATMetric_GetParameters(GATMetric_const metric, GATTable *table); /** GATMetric_GetParameterTypeByName * * The function GATMetric_GetParameterTypeByName gets the type of the * GATMetric parameter value associated with the passed GATMetric parameter * name. * * @param metric The metric to ask for its name. * @param name The name of the parameter to query for. * * @return The type of the associated value. */ GATType GATMetric_GetParameterTypeByName(GATMetric_const metric, char const *name); /** GATMetric_GetParameterByName * * The function GATMetric_GetParameterByName gets the GATMetric * parameter value associated with the passed GATMetric parameter name. There * is returned a 0 (zero) if there is no GATMetric parameter value with the * passed name. * * @param metric The metric to ask for its name. * @param name The name of the parameter to query for. * @param type The expected type of the value to be returned. * @param buffer The buffer, where the retrieved value should be returned to. * @param size The size of the buffer. * * @return An error code. */ GATResult GATMetric_GetParameterByName(GATMetric_const metric, char const *name, GATType type, void *buffer, GATuint32 size); /** GATMetric_CreateMetric * * The function GATMetric_CreateMetric creates a GATMetric object from a given * static metric data. This is a pure helper function for adaptor writers. * * @param data The address of the static metric data. * @param metric The pointer to the variable, which receives the resulting * metric. * * @return An error code. */ GATResult GATMetric_CreateMetric(GATStaticMetric const *data, GATMetric *metric); /** GATMetric_CreateListOfMetrics * * The function GATMetric_CreateListOfMetrics creates a list of GATMetric * objects from a given list of static metric data. This is a pure helper * function for adaptor writers. * * @param data The address of the static metric data array. * @param count The size of the given array of static metric data. * @param list The pointer to the variable, which receives the resulting list * of metrics. * * @return An error code. */ GATResult GATMetric_CreateListOfMetrics(GATStaticMetric *data, GATuint32 count, GATList_GATMetric *list); #ifdef __cplusplus } #endif #endif /* _GATMETRIC_H_ */