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

GATPreferences.h Go to the documentation of this file. /** @file GATPreferences.h * Header file for the GATPreferences class. * * An instance of this class represents the user's preferences for * selecting adaptors. Currently this class is a place holder for * the user preferences, the structure of which is in development; * the matching algorithm outlined in the Match operation is used * by the GAT implementation to determine which capability provider * is used to satisfy a GAT API operation. * * @date $Date: 2004/03/24 19:30:58 $ * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATPreferences.h,v 1.20 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 _GATPREFERENCES_H_ #define _GATPREFERENCES_H_ 1 #include "GATTable.h" #include "GATType.h" #include "GATInternal.h" #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATPreferences); /** * Creates a new GATPreferences instance. * * @return A GATPreferences instance */ GATPreferences GATPreferences_Create(void); /** * This fucntion returns the type, a #GATType of the passed * #GATPreferences_const. This function will always return * #GATType_GATPreferences. * * @param this The #GATPreferences_const to query * @return The #GATType of the passed @c this */ GATType GATPreferences_GetType(GATPreferences_const pref); /** * Tests this #GATPreferences_const for equality with the passed * #GATPreferences_const instance. Two #GATPreferences_const instances * are considered equal if they contain the same set of name/value * pairs. * * @param this The first #GATPreferences_const to compare * @param that The second #GATPreferences_const to compare * @param isequal Result of comparrison * @return Completion status */ GATResult GATPreferences_Equals(GATPreferences_const lhs, GATPreferences_const rhs, GATBool *isequal); /** * This function returns a "deep clone" of the passed #GATPreferences_const @c this. * This "deep clone" is returned in the variable @c thisClone. Furthermore, * this function returns its completion status, through its return value. * * @param this The #GATPreferences_const to clone * @param thisClone The cloned #GATPreferences_const * @return The completion status of this function */ GATResult GATPreferences_Clone(GATPreferences_const pref, GATPreferences *thisClone); /** * Destroys this GATPreferences instance. * * @param this The GATPreferences to destroy */ void GATPreferences_Destroy(GATPreferences *pref); /** GATResult GATPreferences_GetInterface(GATPreferences_const table, GATInterface iftype, void const **ifp) * @brief Get an interface supported by a GATPreferences * * The function GATPreferences_GetInterface allows to get a pointer to an * additional interface supported by this GATPreferences. * * @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 GATPreferences_GetInterface(GATPreferences_const object, GATInterface iftype, void const **ifp); /** * This adds a name/value pair in which the name is a String and the * value is a String to this GATPreferences instance. * * @param this The GATPreferences to modify * @param name Name of the attribute to add * @param value Value of the attribute to add * @return An int indicating the GATError return code */ GATResult GATPreferences_Add(GATPreferences pref, const char *name, const char *value); /** * Removes the name/value pair with the passed name from this * GATPreferences instance. * * @param this The GATPreferences to modify * @param name Name of the name/value to remove. * @return An int indicating the GATError return code */ GATResult GATPreferences_Remove(GATPreferences pref, const char *name); /** * Sets the given GATTable of name/value pairs as preferences. * * @param this The GATPreferences to modify * @param preferences Table of name/value pairs to be used as * preferences. * @return An int indicating the GATError return code */ GATResult GATPreferences_Set(GATPreferences pref, GATTable preferences); /** * Gets the current preferences as name/value pairs in a GATTable. * * @param this The GATPreferences to query * @return Table of name/value pairs containing the current preferences. */ GATTable_const GATPreferences_Get(GATPreferences_const pref); /** * Matches the GATPreferences instance against another GATPreferences * instance expressing criteria. For Match to return true, all keys * present in the criteria table must be present in the original and * must match: a string-valued value in the original table is matched by * a regular expression in the criteria table, and a numeric-valued value * in the original table by a string holding an arithmetical expression * (e.g., "$ < 5 $") in the criteria table. * * @param this The GATPreferences to query * @param criteria Matching criteria. * @param 1 upon match 0 otherwise */ GATBool GATPreferences_Match(GATPreferences_const pref, GATPreferences_const criteria); #ifdef __cplusplus } #endif #endif /* _GATPREFERENCES_H_ */