00001 /* 00002 COSTA: Problem solving environment for data assimilation 00003 Copyright (C) 2005 Nils van Velzen 00004 00005 This library is free software; you can redistribute it and/or 00006 modify it under the terms of the GNU Lesser General Public 00007 License as published by the Free Software Foundation; either 00008 version 2.1 of the License, or (at your option) any later version. 00009 00010 This library is distributed in the hope that it will be useful, 00011 but WITHOUT ANY WARRANTY; without even the implied warranty of 00012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00013 Lesser General Public License for more details. 00014 00015 You should have received a copy of the GNU Lesser General Public 00016 License along with this library; if not, write to the Free Software 00017 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 00018 */ 00019 00020 /** 00021 \file ctai_handles.h 00022 \brief Utility functions for working with CTA_Handle objects. 00023 00024 \note This is just a set of utility routines it does not define any COSTA component 00025 */ 00026 #ifndef NL_VORTECH_CTAI_HANDLES_H 00027 #define NL_VORTECH_CTAI_HANDLES_H 00028 00029 #ifdef __cplusplus 00030 extern "C" { 00031 #endif 00032 00033 /** \brief Get data type of object the given handle is referring to (internal use only!) 00034 * 00035 * \param handle I handle of which to get the data type 00036 * \return data type associated with handle (no error codes) 00037 */ 00038 CTA_Datatype CTAI_Handle_GetDatatype(const CTA_Handle handle); 00039 00040 00041 /** \brief Get name associated with the handle (internal use only!) 00042 * 00043 * \param handle I handle to get name of 00044 * \return pointer to name associated with the given handle 00045 */ 00046 const char *CTAI_Handle_GetName(const CTA_Handle handle); 00047 00048 00049 /** \brief Get data belonging to the handle (internal use only!) 00050 * 00051 * \param handle I handle of which to get the data 00052 * \return constant pointer to the data belonging to the handle 00053 */ 00054 const void *CTAI_Handle_GetData(const CTA_Handle handle); 00055 00056 00057 /** \brief Set name associated with the handle (internal use only!) 00058 * 00059 * \param handle IO handle of which to set the name 00060 * \param name I new name associated with handle 00061 * \return CTA_OK is succesful 00062 */ 00063 int CTAI_Handle_SetName(const CTA_Handle handle, const char *name); 00064 00065 #ifdef __cplusplus 00066 } 00067 #endif 00068 #endif 00069
1.6.1