MISR Toolkit  1.5.1
Public Member Functions
H5::EnumType Class Reference

EnumType is a derivative of a DataType and operates on HDF5 enum datatypes. More...

#include <H5EnumType.h>

Inheritance diagram for H5::EnumType:
Inheritance graph
Collaboration diagram for H5::EnumType:
Collaboration graph

Public Member Functions

 EnumType (size_t size)
 
 EnumType (const DataSet &dataset)
 
 EnumType (const IntType &data_type)
 
 EnumType (const H5Location &loc, const char *name)
 
 EnumType (const H5Location &loc, const H5std_string &name)
 
virtual DataType * decode () const
 
int getNmembers () const
 
int getMemberIndex (const char *name) const
 
int getMemberIndex (const H5std_string &name) const
 
void getMemberValue (unsigned memb_no, void *value) const
 
void insert (const char *name, void *value) const
 
void insert (const H5std_string &name, void *value) const
 
H5std_string nameOf (void *value, size_t size) const
 
void valueOf (const char *name, void *value) const
 
void valueOf (const H5std_string &name, void *value) const
 
virtual H5std_string fromClass () const
 Returns this class name. More...
 
 EnumType ()
 
 EnumType (const hid_t existing_id)
 
 EnumType (const EnumType &original)
 
virtual ~EnumType ()
 
- Public Member Functions inherited from H5::DataType
 DataType (const H5T_class_t type_class, size_t size)
 
 DataType (const DataType &original)
 
 DataType (const PredType &pred_type)
 
 DataType (const H5Location &loc, const char *name)
 
 DataType (const H5Location &loc, const H5std_string &name)
 
 DataType (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
 
 DataType (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
 
virtual void close ()
 
void copy (const DataType &like_type)
 
void copy (const DataSet &dset)
 
void encode ()
 
H5T_class_t getClass () const
 
void commit (const H5Location &loc, const char *name)
 
void commit (const H5Location &loc, const H5std_string &name)
 
bool committed () const
 
H5T_conv_t find (const DataType &dest, H5T_cdata_t **pcdata) const
 
void convert (const DataType &dest, size_t nelmts, void *buf, void *background, const PropList &plist=PropList::DEFAULT) const
 
DataType & operator= (const DataType &rhs)
 
bool operator== (const DataType &compared_type) const
 
void lock () const
 
size_t getSize () const
 
DataType getSuper () const
 
void registerFunc (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const
 
void registerFunc (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const
 
void unregister (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const
 
void unregister (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const
 
void setTag (const char *tag) const
 
void setTag (const H5std_string &tag) const
 
H5std_string getTag () const
 
bool detectClass (H5T_class_t cls) const
 
bool isVariableStr () const
 
PropList getCreatePlist () const
 
virtual void throwException (const H5std_string &func_name, const H5std_string &msg) const
 
 DataType (const hid_t type_id)
 
 DataType ()
 
bool hasBinaryDesc () const
 
virtual hid_t getId () const
 Returns an identifier. (pure virtual) More...
 
virtual ~DataType ()
 
- Public Member Functions inherited from H5::H5Object
Attribute createAttribute (const char *name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const
 
Attribute createAttribute (const H5std_string &name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const
 
Attribute openAttribute (const char *name) const
 
Attribute openAttribute (const H5std_string &name) const
 
Attribute openAttribute (const unsigned int idx) const
 
int getNumAttrs () const
 
bool attrExists (const char *name) const
 
bool attrExists (const H5std_string &name) const
 
void renameAttr (const char *oldname, const char *newname) const
 
void renameAttr (const H5std_string &oldname, const H5std_string &newname) const
 
void removeAttr (const char *name) const
 
void removeAttr (const H5std_string &name) const
 
ssize_t getObjName (char *obj_name, size_t buf_size=0) const
 
ssize_t getObjName (H5std_string &obj_name, size_t len=0) const
 
H5std_string getObjName () const
 
virtual ~H5Object ()
 
- Public Member Functions inherited from H5::H5Location
int getNumAttrs () const
 
bool nameExists (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
bool nameExists (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void flush (H5F_scope_t scope) const
 
H5std_string getFileName () const
 
void getObjectInfo (H5O_info_t *oinfo) const
 
void getObjectInfo (const char *name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void getObjectInfo (const H5std_string &name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
H5G_obj_t getObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const
 
H5O_type_t getRefObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const
 
unsigned objVersion () const
 
void setComment (const char *name, const char *comment) const
 
void setComment (const H5std_string &name, const H5std_string &comment) const
 
void setComment (const char *comment) const
 
void setComment (const H5std_string &comment) const
 
ssize_t getComment (const char *name, size_t buf_size, char *comment) const
 
H5std_string getComment (const char *name, size_t buf_size=0) const
 
H5std_string getComment (const H5std_string &name, size_t buf_size=0) const
 
void removeComment (const char *name) const
 
void removeComment (const H5std_string &name) const
 
void reference (void *ref, const char *name, H5R_type_t ref_type=H5R_OBJECT) const
 
void reference (void *ref, const H5std_string &name, H5R_type_t ref_type=H5R_OBJECT) const
 
void reference (void *ref, const char *name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const
 
void reference (void *ref, const H5std_string &name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const
 
void dereference (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
 
void dereference (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)
 
DataSpace getRegion (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const
 
hid_t openObjId (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
hid_t openObjId (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void link (const char *target_name, const char *link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void link (const H5std_string &target_name, const H5std_string &link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void link (const char *curr_name, const H5Location &new_loc, const char *new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void link (const H5std_string &curr_name, const H5Location &new_loc, const H5std_string &new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void link (const char *curr_name, const hid_t same_loc, const char *new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void link (const H5std_string &curr_name, const hid_t same_loc, const H5std_string &new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void unlink (const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void unlink (const H5std_string &link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void copyLink (const char *src_name, const H5Location &dst, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void copyLink (const H5std_string &src_name, const H5Location &dst, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void copyLink (const char *src_name, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void copyLink (const H5std_string &src_name, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void moveLink (const char *src_name, const H5Location &dst, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void moveLink (const H5std_string &src_name, const H5Location &dst, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void moveLink (const char *src_name, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
void moveLink (const H5std_string &src_name, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
H5L_info_t getLinkInfo (const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
H5L_info_t getLinkInfo (const H5std_string &link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
 
H5std_string getLinkval (const char *link_name, size_t size=0) const
 
H5std_string getLinkval (const H5std_string &link_name, size_t size=0) const
 
virtual int iterateAttrs (attr_operator_t user_op, unsigned *idx=NULL, void *op_data=NULL)
 
- Public Member Functions inherited from H5::IdComponent
void incRefCount (const hid_t obj_id) const
 
void incRefCount () const
 
void decRefCount (const hid_t obj_id) const
 
void decRefCount () const
 
int getCounter (const hid_t obj_id) const
 
int getCounter () const
 
H5I_type_t getHDFObjType () const
 
IdComponent & operator= (const IdComponent &rhs)
 
void setId (const hid_t new_id)
 
H5std_string inMemFunc (const char *func_name) const
 
virtual ~IdComponent ()
 

Additional Inherited Members

- Static Public Member Functions inherited from H5::H5Location
static void closeObjId (hid_t obj_id)
 
- Static Public Member Functions inherited from H5::IdComponent
static H5I_type_t getHDFObjType (const hid_t obj_id)
 
static bool isValid (hid_t an_id)
 
- Protected Member Functions inherited from H5::DataType
hid_t p_decode () const
 
virtual void p_setId (const hid_t new_id)
 
hid_t p_opentype (const H5Location &loc, const char *dtype_name) const
 
- Protected Member Functions inherited from H5::H5Object
 H5Object ()
 
- Protected Member Functions inherited from H5::H5Location
 H5Location ()
 
 H5Location (const hid_t loc_id)
 
void p_reference (void *ref, const char *name, hid_t space_id, H5R_type_t ref_type) const
 
hid_t p_dereference (hid_t loc_id, const void *ref, H5R_type_t ref_type, const char *from_func)
 
H5G_obj_t p_get_obj_type (void *ref, H5R_type_t ref_type) const
 
H5O_type_t p_get_ref_obj_type (void *ref, H5R_type_t ref_type) const
 
virtual ~H5Location ()
 
- Protected Member Functions inherited from H5::IdComponent
 IdComponent ()
 
H5std_string p_get_file_name () const
 
- Static Protected Member Functions inherited from H5::IdComponent
static bool p_valid_id (const hid_t obj_id)
 
- Protected Attributes inherited from H5::DataType
hid_t id
 
- Static Protected Attributes inherited from H5::IdComponent
static bool H5dontAtexit_called
 

Detailed Description

EnumType is a derivative of a DataType and operates on HDF5 enum datatypes.

Definition at line 25 of file H5EnumType.h.

Constructor & Destructor Documentation

◆ EnumType() [1/8]

H5::EnumType::EnumType ( size_t  size)

◆ EnumType() [2/8]

H5::EnumType::EnumType ( const DataSet &  dataset)

◆ EnumType() [3/8]

H5::EnumType::EnumType ( const IntType &  data_type)

◆ EnumType() [4/8]

H5::EnumType::EnumType ( const H5Location &  loc,
const char *  name 
)

◆ EnumType() [5/8]

H5::EnumType::EnumType ( const H5Location &  loc,
const H5std_string &  name 
)

◆ EnumType() [6/8]

H5::EnumType::EnumType ( )

◆ EnumType() [7/8]

H5::EnumType::EnumType ( const hid_t  existing_id)

◆ EnumType() [8/8]

H5::EnumType::EnumType ( const EnumType &  original)

◆ ~EnumType()

virtual H5::EnumType::~EnumType ( )
virtual

Member Function Documentation

◆ decode()

virtual DataType* H5::EnumType::decode ( ) const
virtual

Reimplemented from H5::DataType.

◆ fromClass()

virtual H5std_string H5::EnumType::fromClass ( ) const
inlinevirtual

Returns this class name.

Reimplemented from H5::DataType.

Definition at line 69 of file H5EnumType.h.

◆ getMemberIndex() [1/2]

int H5::EnumType::getMemberIndex ( const char *  name) const

◆ getMemberIndex() [2/2]

int H5::EnumType::getMemberIndex ( const H5std_string &  name) const

◆ getMemberValue()

void H5::EnumType::getMemberValue ( unsigned  memb_no,
void *  value 
) const

◆ getNmembers()

int H5::EnumType::getNmembers ( ) const

◆ insert() [1/2]

void H5::EnumType::insert ( const char *  name,
void *  value 
) const

◆ insert() [2/2]

void H5::EnumType::insert ( const H5std_string &  name,
void *  value 
) const

◆ nameOf()

H5std_string H5::EnumType::nameOf ( void *  value,
size_t  size 
) const

◆ valueOf() [1/2]

void H5::EnumType::valueOf ( const char *  name,
void *  value 
) const

◆ valueOf() [2/2]

void H5::EnumType::valueOf ( const H5std_string &  name,
void *  value 
) const
The documentation for this class was generated from the following file:
MISR Toolkit - Copyright © 2005 - 2020 Jet Propulsion Laboratory
Generated on Fri Jun 19 2020 22:49:54