MISR Toolkit  1.5.1
Public Member Functions | Protected Member Functions
H5::H5Object Class Reference

Class H5Object is a bridge between H5Location and DataSet, DataType, and Group. More...

#include <H5Object.h>

Inheritance diagram for H5::H5Object:
Inheritance graph
Collaboration diagram for H5::H5Object:
Collaboration graph

Public Member Functions

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 hid_t getId () const =0
 Returns an identifier. (pure virtual) More...
 
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)
 
virtual void throwException (const H5std_string &func_name, const H5std_string &msg) const
 
virtual void close ()=0
 
H5std_string inMemFunc (const char *func_name) const
 
virtual H5std_string fromClass () const
 Returns this class name. More...
 
virtual ~IdComponent ()
 

Protected Member Functions

 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 void p_setId (const hid_t new_id)=0
 
virtual ~H5Location ()
 
- Protected Member Functions inherited from H5::IdComponent
 IdComponent ()
 
H5std_string p_get_file_name () const
 

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)
 
- Static Protected Member Functions inherited from H5::IdComponent
static bool p_valid_id (const hid_t obj_id)
 
- Static Protected Attributes inherited from H5::IdComponent
static bool H5dontAtexit_called
 

Detailed Description

Class H5Object is a bridge between H5Location and DataSet, DataType, and Group.

Modification: Sept 18, 2012: Added class H5Location in between IdComponent and H5Object. An H5File now inherits from H5Location. All HDF5 wrappers in H5Object are moved up to H5Location. H5Object is left mostly empty for future wrappers that are only for group, dataset, and named datatype. Note that the reason for adding H5Location instead of simply moving H5File to be under H5Object is H5File is not an HDF5 object, and renaming H5Object to H5Location will risk breaking user applications. -BMR Apr 2, 2014: Added wrapper getObjName for H5Iget_name -BMR

Definition at line 37 of file H5Object.h.

Constructor & Destructor Documentation

◆ ~H5Object()

virtual H5::H5Object::~H5Object ( )
virtual

◆ H5Object()

H5::H5Object::H5Object ( )
protected

Member Function Documentation

◆ attrExists() [1/2]

bool H5::H5Object::attrExists ( const char *  name) const

◆ attrExists() [2/2]

bool H5::H5Object::attrExists ( const H5std_string &  name) const

◆ createAttribute() [1/2]

Attribute H5::H5Object::createAttribute ( const char *  name,
const DataType &  type,
const DataSpace &  space,
const PropList &  create_plist = PropList::DEFAULT 
) const

◆ createAttribute() [2/2]

Attribute H5::H5Object::createAttribute ( const H5std_string &  name,
const DataType &  type,
const DataSpace &  space,
const PropList &  create_plist = PropList::DEFAULT 
) const

◆ getNumAttrs()

int H5::H5Object::getNumAttrs ( ) const

◆ getObjName() [1/3]

ssize_t H5::H5Object::getObjName ( char *  obj_name,
size_t  buf_size = 0 
) const

◆ getObjName() [2/3]

ssize_t H5::H5Object::getObjName ( H5std_string &  obj_name,
size_t  len = 0 
) const

◆ getObjName() [3/3]

H5std_string H5::H5Object::getObjName ( ) const

◆ openAttribute() [1/3]

Attribute H5::H5Object::openAttribute ( const char *  name) const

◆ openAttribute() [2/3]

Attribute H5::H5Object::openAttribute ( const H5std_string &  name) const

◆ openAttribute() [3/3]

Attribute H5::H5Object::openAttribute ( const unsigned int  idx) const

◆ removeAttr() [1/2]

void H5::H5Object::removeAttr ( const char *  name) const

◆ removeAttr() [2/2]

void H5::H5Object::removeAttr ( const H5std_string &  name) const

◆ renameAttr() [1/2]

void H5::H5Object::renameAttr ( const char *  oldname,
const char *  newname 
) const

◆ renameAttr() [2/2]

void H5::H5Object::renameAttr ( const H5std_string &  oldname,
const H5std_string &  newname 
) 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