F5Fmeta.h

Go to the documentation of this file.

/*
//
// $Id: F5Fmeta.h, 2013/12/10 10:14 marcel $
//
*/
 
#ifndef __F5F_META_H
#define __F5F_META_H
 
#include "F5L.h"
#include "F5Bchart.h"
#include "F5Path.h"
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
F5_API int F5Fopen_group_or_dataset( F5Path*f, const char* name, hid_t*gid, hid_t*did );
 
F5_DEPRECATED("Function is conflicting with F5F API", F5_API int F5Fopen_group_or_dataset_attribute( F5Path*f, const char* attribute_name, hid_t gid, hid_t did, hsize_t N, hid_t*attr_id, hid_t*space_id ); )
 
F5_API int F5Fopen_or_create_group_or_dataset_attribute( F5Path*f, const char* attribute_name, hid_t gid, hid_t did, hsize_t N,  hid_t type_id, int force, hid_t*space_id, hid_t*attr_id );
 
F5_DEPRECATED( "Function does not provide benefits over raw HDF5 call", F5_API int F5Fread_attr_data( void*data, hsize_t N, hid_t type_id, hid_t attr_id, const char*attribute_name ) );
F5_DEPRECATED( "Function does not provide benefits over raw HDF5 call", F5_API int F5Fwrite_attr_data( const void*data, hsize_t N, hid_t type_id, hid_t attr_id, const char*attribute_name ) );
 
 
/**
     Helper function.
     Retrieve an attribute of 2 values (e.g. 2 float, 2 doubles, 2 ints, 2 F5_vec3_float_t ... ) from a fragment.
     @return: 1 in case of error, 0 otherwise.
*/
F5_API int F5Fget_attribute( F5Path*f, const char*attribute_name,
                             void*data, hsize_t N, hid_t mem_type_id );
 
F5_API int F5Fset_attribute( F5Path*f, const char*attribute_name,
                             const void*data, hsize_t N, hid_t mem_type_id, int force );
 
F5_API int F5Fget_fragment_attribute( F5Path*f, const char*fragment_name, const char*attribute_name,
                                      void*data, hsize_t N, hid_t mem_type_id );
 
F5_API int F5Fset_fragment_attribute( F5Path*f, const char*fragment_name, const char*attribute_name,
                                      const void*data, hsize_t N, hid_t mem_type_id, int force );
 
F5_API int F5Fset_string_attribute(F5Path*f, const char*fragment_name, const char* attribute_name, const char*text, int force );
F5_API int F5Fget_string_attribute(F5Path*f, const char*fragment_name, const char* attribute_name, char**text );
 
/**
 * Test whether a field attribute exists or not
 * @return 1 if exists, 0 otherwise
 */
F5_API int F5Fhas_attribute(F5Path*f, const char*attr_name);
 
F5_API hssize_t F5Fget_attribute_nr_elements( F5Path*f, const char*fragment_name, const char*attribute_name );
 
/**
 * Test whether a field fragment attribute exists or not
 * @return 1 if exists, 0 otherwise
 */
 
F5_API int F5Fhas_fragment_attribute(F5Path*f, const char*fragment_name, const char*attribute_name);
 
 
F5_API int F5Fis_attribute_of_type(F5Path*f, const char*attribute_name, hid_t HDF5_type);
F5_API int F5Fis_fragment_attribute_of_type(F5Path*f, const char*attribute_name, const char*fragment_name, hid_t HDF5_type);
 
/*F5_API int F5Fset_range2(F5Path*f, const char*fragment_name, const void*minmax, unsigned force);*/
 
 
/**
 * Test if range attribute is of certain type
 * @return 1 if matching, 0 otherwise
 */
F5_API int F5Fis_range_of_type(F5Path*f, const char*fragment_name, hid_t HDF5_type);
 
 
/**
   Field attribute (optional): Bounding box including the ghost zone.
 */
F5_API int F5Fget_fragment_range_ghost(F5Path*f, const char*fragment_name, void*minmax, void*minmax_ghost, hid_t mem_type_id );
F5_API int F5Fget_fragment_range_ghost2(F5Path*f, const char*fragment_name, void*minmax_ghost );
F5_API int F5Fset_fragment_range_ghost2(F5Path*f, const char*fragment_name, const void*minmax, const void*minmax_ghost, unsigned force );
F5_API int F5Fset_fragment_range_ghost(F5Path*f, const char*fragment_name, const void*minmax, const void*minmax_ghost );
 
 
/** If available a data-array icludes values of a ghost zone and the array is partitioned in two contiguous parts. The first part contains the values inside the fragment and has size size_real, the second part contains the value inside the ghost zone with size size_ghost.
   */
F5_API int F5Fget_fragment_ghost_size(F5Path*f,  const char*fragment_name, unsigned long* size_real, unsigned long* size_ghost);
F5_API int F5Fset_fragment_ghost_size(F5Path*f,  const char*fragment_name, unsigned long size_real,  unsigned long size_ghost, int force);
 
 
/**
   Field attribute (optional): The average value of a dataset.
 */
F5_API int F5Fget_average(F5Path*f,  const char*fragment_name,     void*avg);
F5_API int F5Fset_average2(F5Path*f, const char*fragment_name,const void*avg, int force);
F5_API int F5Fset_average(F5Path*f, const char*fragment_name,const void*avg);
 
/**
   Field attribute (optional): The standard deviation
   of data values from a field's average value.
 */
F5_API int F5Fget_deviation(F5Path*f,  const char*fragment_name,     void*dev);
F5_API int F5Fset_deviation2(F5Path*f, const char*fragment_name, const void*dev, int force);
F5_API int F5Fset_deviation(F5Path*f, const char*fragment_name, const void*dev);
 
/**
   Field attribute (optional): The histogram of a scalar field.
 */
F5_API int F5Fget_histogram(  F5Path*f, const char*fragment_name, unsigned long*histogram, hsize_t size);
F5_API int F5Fset_histogram2( F5Path*f, const char*fragment_name, const unsigned long*his, hsize_t size, int force);
F5_API int F5Fset_histogram(  F5Path*f, const char*fragment_name, const unsigned long*his, hsize_t size);
 
 
F5_API int F5Fset_original_type2( F5Path*f, const char*fragment_name, int force);
 
/** Field attribute (optional): A dictionary of words and a stored as string attribute, along with a seperator
    i.e. used for a field containing integer indeces into the dictionary (label-field)
    The get function does not allocate the string buffers
  */
F5_API int F5Fset_dictionary2( F5Path*f, const char*fragment_name, const char*dictionary, const F5_uint16_t* words, int word_count, int force );
F5_API int F5Fset_dictionary(  F5Path*f, const char*fragment_name, const char*dictionary, const F5_uint16_t* words, int word_count, int force );
 
        /** Dictionary string has to be passed by reference. Dynamic memory is reserved for the dictionary and must be released afterwards.
            e.g. :
            char* dict;
            F5Fget_dictionary(f, NULL, &dict, .. );
            free(dictionary)
         */
F5_API int F5Fget_dictionary(  F5Path*f, const char*fragment_name, char**dictionary, F5_uint16_t*words, int word_count );
 
 
 
/** Adds a string attribute to describe units to a data field.
    The F5Path must contain a valid Field_hid identifier, which2
    may be either a group or a dataset.
    This function will set an attribute named F5_METRIC_UNIT_DESCRIPTION
    to the given object, which can be an arbitrary string.
 
    @note This unit description is only supposed to provide means
    for human interpretation, not for defining units in a programmatic
    way. Thus, the given string can be arbitrary,
 
 
    @return -1 in case of error
 
    @todo Make this function using a char* and length such that it
          can be called directly from an c++ string and does not
          require the string to be 0-terminated. This needs to be
          supported in the function implementation as well.
   */
F5_API int F5Fset_metric_unit_description(F5Path*f, const char*unit);
 
 
#ifdef  __cplusplus
}    /* extern "C" */
#endif
 
#endif  /* __F5F_META_H */