MISR Toolkit  1.5.1
Public Member Functions | Static Public Member Functions | Protected Member Functions
H5::H5Location Class Referenceabstract

H5Location is an abstract base class, providing a collection of wrappers of the C functions that take a location identifier, which can be either file, group, dataset, attribute, or named datatype. More...

#include <H5Location.h>

Inheritance diagram for H5::H5Location:
Inheritance graph
Collaboration diagram for H5::H5Location:
Collaboration graph

Public Member Functions

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 ()
 

Static Public Member Functions

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

 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 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

H5Location is an abstract base class, providing a collection of wrappers of the C functions that take a location identifier, which can be either file, group, dataset, attribute, or named datatype.

Definition at line 42 of file H5Location.h.

Constructor & Destructor Documentation

◆ H5Location() [1/2]

H5::H5Location::H5Location ( )
protected

◆ H5Location() [2/2]

H5::H5Location::H5Location ( const hid_t  loc_id)
protected

◆ ~H5Location()

virtual H5::H5Location::~H5Location ( )
protectedvirtual

Member Function Documentation

◆ closeObjId()

static void H5::H5Location::closeObjId ( hid_t  obj_id)
static

◆ copyLink() [1/4]

void H5::H5Location::copyLink ( const char *  src_name,
const H5Location &  dst,
const char *  dst_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ copyLink() [2/4]

void H5::H5Location::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

◆ copyLink() [3/4]

void H5::H5Location::copyLink ( const char *  src_name,
const char *  dst_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ copyLink() [4/4]

void H5::H5Location::copyLink ( const H5std_string &  src_name,
const H5std_string &  dst_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ dereference() [1/2]

void H5::H5Location::dereference ( const H5Location &  loc,
const void *  ref,
H5R_type_t  ref_type = H5R_OBJECT 
)

◆ dereference() [2/2]

void H5::H5Location::dereference ( const Attribute &  attr,
const void *  ref,
H5R_type_t  ref_type = H5R_OBJECT 
)

◆ flush()

void H5::H5Location::flush ( H5F_scope_t  scope) const

◆ getComment() [1/3]

ssize_t H5::H5Location::getComment ( const char *  name,
size_t  buf_size,
char *  comment 
) const

◆ getComment() [2/3]

H5std_string H5::H5Location::getComment ( const char *  name,
size_t  buf_size = 0 
) const

◆ getComment() [3/3]

H5std_string H5::H5Location::getComment ( const H5std_string &  name,
size_t  buf_size = 0 
) const

◆ getFileName()

H5std_string H5::H5Location::getFileName ( ) const

◆ getId()

virtual hid_t H5::H5Location::getId ( ) const
pure virtual

Returns an identifier. (pure virtual)

Implements H5::IdComponent.

Implemented in H5::DataType, H5::H5File, H5::DataSet, H5::Attribute, and H5::Group.

◆ getLinkInfo() [1/2]

H5L_info_t H5::H5Location::getLinkInfo ( const char *  link_name,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ getLinkInfo() [2/2]

H5L_info_t H5::H5Location::getLinkInfo ( const H5std_string &  link_name,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ getLinkval() [1/2]

H5std_string H5::H5Location::getLinkval ( const char *  link_name,
size_t  size = 0 
) const

◆ getLinkval() [2/2]

H5std_string H5::H5Location::getLinkval ( const H5std_string &  link_name,
size_t  size = 0 
) const

◆ getNumAttrs()

int H5::H5Location::getNumAttrs ( ) const

◆ getObjectInfo() [1/3]

void H5::H5Location::getObjectInfo ( H5O_info_t *  oinfo) const

◆ getObjectInfo() [2/3]

void H5::H5Location::getObjectInfo ( const char *  name,
H5O_info_t *  oinfo,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ getObjectInfo() [3/3]

void H5::H5Location::getObjectInfo ( const H5std_string &  name,
H5O_info_t *  oinfo,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ getObjType()

H5G_obj_t H5::H5Location::getObjType ( void *  ref,
H5R_type_t  ref_type = H5R_OBJECT 
) const

◆ getRefObjType()

H5O_type_t H5::H5Location::getRefObjType ( void *  ref,
H5R_type_t  ref_type = H5R_OBJECT 
) const

◆ getRegion()

DataSpace H5::H5Location::getRegion ( void *  ref,
H5R_type_t  ref_type = H5R_DATASET_REGION 
) const

◆ iterateAttrs()

virtual int H5::H5Location::iterateAttrs ( attr_operator_t  user_op,
unsigned *  idx = NULL,
void *  op_data = NULL 
)
virtual

◆ link() [1/6]

void H5::H5Location::link ( const char *  target_name,
const char *  link_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ link() [2/6]

void H5::H5Location::link ( const H5std_string &  target_name,
const H5std_string &  link_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ link() [3/6]

void H5::H5Location::link ( const char *  curr_name,
const H5Location &  new_loc,
const char *  new_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ link() [4/6]

void H5::H5Location::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

◆ link() [5/6]

void H5::H5Location::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

◆ link() [6/6]

void H5::H5Location::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

◆ moveLink() [1/4]

void H5::H5Location::moveLink ( const char *  src_name,
const H5Location &  dst,
const char *  dst_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ moveLink() [2/4]

void H5::H5Location::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

◆ moveLink() [3/4]

void H5::H5Location::moveLink ( const char *  src_name,
const char *  dst_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ moveLink() [4/4]

void H5::H5Location::moveLink ( const H5std_string &  src_name,
const H5std_string &  dst_name,
const LinkCreatPropList &  lcpl = LinkCreatPropList::DEFAULT,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ nameExists() [1/2]

bool H5::H5Location::nameExists ( const char *  name,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ nameExists() [2/2]

bool H5::H5Location::nameExists ( const H5std_string &  name,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ objVersion()

unsigned H5::H5Location::objVersion ( ) const

◆ openObjId() [1/2]

hid_t H5::H5Location::openObjId ( const char *  name,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ openObjId() [2/2]

hid_t H5::H5Location::openObjId ( const H5std_string &  name,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ p_dereference()

hid_t H5::H5Location::p_dereference ( hid_t  loc_id,
const void *  ref,
H5R_type_t  ref_type,
const char *  from_func 
)
protected

◆ p_get_obj_type()

H5G_obj_t H5::H5Location::p_get_obj_type ( void *  ref,
H5R_type_t  ref_type 
) const
protected

◆ p_get_ref_obj_type()

H5O_type_t H5::H5Location::p_get_ref_obj_type ( void *  ref,
H5R_type_t  ref_type 
) const
protected

◆ p_reference()

void H5::H5Location::p_reference ( void *  ref,
const char *  name,
hid_t  space_id,
H5R_type_t  ref_type 
) const
protected

◆ p_setId()

virtual void H5::H5Location::p_setId ( const hid_t  new_id)
protectedpure virtual

Implements H5::IdComponent.

Implemented in H5::DataType, H5::H5File, H5::DataSet, H5::Attribute, and H5::Group.

◆ reference() [1/4]

void H5::H5Location::reference ( void *  ref,
const char *  name,
H5R_type_t  ref_type = H5R_OBJECT 
) const

◆ reference() [2/4]

void H5::H5Location::reference ( void *  ref,
const H5std_string &  name,
H5R_type_t  ref_type = H5R_OBJECT 
) const

◆ reference() [3/4]

void H5::H5Location::reference ( void *  ref,
const char *  name,
const DataSpace &  dataspace,
H5R_type_t  ref_type = H5R_DATASET_REGION 
) const

◆ reference() [4/4]

void H5::H5Location::reference ( void *  ref,
const H5std_string &  name,
const DataSpace &  dataspace,
H5R_type_t  ref_type = H5R_DATASET_REGION 
) const

◆ removeComment() [1/2]

void H5::H5Location::removeComment ( const char *  name) const

◆ removeComment() [2/2]

void H5::H5Location::removeComment ( const H5std_string &  name) const

◆ setComment() [1/4]

void H5::H5Location::setComment ( const char *  name,
const char *  comment 
) const

◆ setComment() [2/4]

void H5::H5Location::setComment ( const H5std_string &  name,
const H5std_string &  comment 
) const

◆ setComment() [3/4]

void H5::H5Location::setComment ( const char *  comment) const

◆ setComment() [4/4]

void H5::H5Location::setComment ( const H5std_string &  comment) const

◆ unlink() [1/2]

void H5::H5Location::unlink ( const char *  link_name,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) const

◆ unlink() [2/2]

void H5::H5Location::unlink ( const H5std_string &  link_name,
const LinkAccPropList &  lapl = LinkAccPropList::DEFAULT 
) 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