Public Member Functions

Hdf_vd_field Class Reference

List of all members.

Public Member Functions

 Hdf_vd_field (const char *vd_name, const int32 &type, const int32 &order, const int32 &size, const int32 &vd_id=-1, const int32 &field_idx=-1)
 create a VData storage object
 Hdf_vd_field (const Hdf_vd_field &hdf_vd)
Hdf_vd_fieldoperator= (const Hdf_vd_field &hdf_vd)
std::string get_name () const
int32 get_type () const
int32 get_order () const
int32 get_size () const
void set_name (const string &name)
void set_type (const int32 &type)
void set_order (const int32 &order)
void set_size (const int32 &size)
int32 get_nb_attr () const
Hdf_attr get_attribute (const char *attr_name) const
 access an attribute using its name
Hdf_attr get_attribute (const int32 &attr_idx) const
 access an attribute using its index
const bool has_attr (const char *attr_name) const
 test the existence of the attribute
void get_attr_value (const char *attr_name, void *value, int32 ival=0) const
 read the value of an attribute
std::string to_string () const

Detailed Description

vdata field


Constructor & Destructor Documentation

Hdf_vd_field::Hdf_vd_field ( const char *  vd_name,
const int32 &  type,
const int32 &  order,
const int32 &  size,
const int32 &  vd_id = -1,
const int32 &  field_idx = -1 
)

create a VData storage object

Parameters:
name the name of the field
type the type of the field's datas
order the order of the field
vd_id the id number of the VData that contains this field
field_idx the index of this field in the VData's ones

References Hdf_vd_field().

Referenced by Hdf_vd_field().


Member Function Documentation

void Hdf_vd_field::get_attr_value ( const char *  attr_name,
void *  value,
int32  ival = 0 
) const

read the value of an attribute

Parameters:
attr_name the name of the attribute
value the output value (must be allocated by the caller)
ival the index of the attribute value (for array attributes)

References get_attribute().

Hdf_attr Hdf_vd_field::get_attribute ( const char *  attr_name  )  const

access an attribute using its name

Parameters:
attr_name the attribute name
Returns:
the attribute.
Exceptions:
bad_attribute_name if the attribute doesn't exists

Referenced by get_attr_value().

Hdf_attr Hdf_vd_field::get_attribute ( const int32 &  attr_idx  )  const

access an attribute using its index

Parameters:
attr_idx the attribute index
Returns:
the attribute.
Exceptions:
bad_attribute_index if the attribute doesn't exists
const bool Hdf_vd_field::has_attr ( const char *  attr_name  )  const

test the existence of the attribute

Parameters:
attr_name the name of the attribute
Returns:
true if the attribute has been found

The documentation for this class was generated from the following files: