rave_attribute.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2009 Swedish Meteorological and Hydrological Institute, SMHI,
 
This file is part of RAVE.
 
RAVE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
RAVE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License
along with RAVE.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------*/
#ifndef RAVE_ATTRIBUTE_H
#define RAVE_ATTRIBUTE_H
#include "rave_object.h"
#include "rave_types.h"
#include <stdarg.h>
 
typedef enum RaveAttribute_Format {
  RaveAttribute_Format_Undefined = -1, 
  RaveAttribute_Format_String = 0,     
  RaveAttribute_Format_Long = 1,       
  RaveAttribute_Format_Double = 2,     
  RaveAttribute_Format_LongArray = 3,  
  RaveAttribute_Format_DoubleArray = 4 
} RaveAttribute_Format;
 
typedef struct _RaveAttribute_t RaveAttribute_t;
 
extern RaveCoreObjectType RaveAttribute_TYPE;
 
int RaveAttribute_setName(RaveAttribute_t* attr, const char* name);
 
const char* RaveAttribute_getName(RaveAttribute_t* attr);
 
RaveAttribute_Format RaveAttribute_getFormat(RaveAttribute_t* attr);
 
void RaveAttribute_setLong(RaveAttribute_t* attr, long value);
 
void RaveAttribute_setDouble(RaveAttribute_t* attr, double value);
 
int RaveAttribute_setString(RaveAttribute_t* attr, const char* value);
 
int RaveAttribute_setLongArray(RaveAttribute_t* attr, long* value, int len);
 
int RaveAttribute_setDoubleArray(RaveAttribute_t* attr, double* value, int len);
 
int RaveAttribute_setArrayFromData(RaveAttribute_t* attr, void* value, int len, RaveDataType type);
 
int RaveAttribute_getLong(RaveAttribute_t* attr, long* value);
 
int RaveAttribute_getDouble(RaveAttribute_t* attr, double* value);
 
int RaveAttribute_getString(RaveAttribute_t* attr, char** value);
 
int RaveAttribute_getLongArray(RaveAttribute_t* attr, long** value, int* len);
 
int RaveAttribute_getDoubleArray(RaveAttribute_t* attr, double** value, int* len);
 
int RaveAttribute_shiftArray(RaveAttribute_t* attr, int nx);
 
int RaveAttributeHelp_extractGroupAndName(
  const char* attrname, char** group, char** name);
 
int RaveAttributeHelp_validateHowGroupAttributeName(const char* gname, const char* aname);
 
RaveAttribute_t* RaveAttributeHelp_createNamedAttribute(const char* name);
 
RaveAttribute_t* RaveAttributeHelp_createLong(const char* name, long value);
 
RaveAttribute_t* RaveAttributeHelp_createDouble(const char* name, double value);
 
RaveAttribute_t* RaveAttributeHelp_createDoubleFromString(const char* name, const char* value);
 
RaveAttribute_t* RaveAttributeHelp_createString(const char* name, const char* value);
 
RaveAttribute_t* RaveAttributeHelp_createLongArray(const char* name, long* value, int len);
 
RaveAttribute_t* RaveAttributeHelp_createDoubleArray(const char* name, double* value, int len);
 
RaveAttribute_t* RaveAttributeHelp_createArrayFromData(const char* name, void* value, int len, RaveDataType type);
 
RaveAttribute_t* RaveAttributeHelp_createStringFmt(const char* name, const char* fmt, ...);
 
#endif /* RAVE_ATTRIBUTE_H */