MISR Toolkit  1.5.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Static Protected Attributes | Static Private Attributes
H5::IdComponent Class Referenceabstract

Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier. More...

#include <H5IdComponent.h>

Inheritance diagram for H5::IdComponent:
Inheritance graph
Collaboration diagram for H5::IdComponent:
Collaboration graph

Public Member Functions

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
 
IdComponentoperator= (const IdComponent &rhs)
 
void setId (const hid_t new_id)
 
virtual hid_t getId () const =0
 
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 H5I_type_t getHDFObjType (const hid_t obj_id)
 
static bool isValid (hid_t an_id)
 

Protected Member Functions

 IdComponent ()
 
H5std_string p_get_file_name () const
 
virtual void p_setId (const hid_t new_id)=0
 

Static Protected Member Functions

static bool p_valid_id (const hid_t obj_id)
 

Static Protected Attributes

static bool H5dontAtexit_called
 

Static Private Attributes

static bool H5cppinit
 

Detailed Description

Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier.

In most cases, the C library handles these operations and an application rarely needs them.

Definition at line 27 of file H5IdComponent.h.

Constructor & Destructor Documentation

◆ ~IdComponent()

virtual H5::IdComponent::~IdComponent ( )
virtual

◆ IdComponent()

H5::IdComponent::IdComponent ( )
protected

Member Function Documentation

◆ close()

virtual void H5::IdComponent::close ( )
pure virtual

◆ decRefCount() [1/2]

void H5::IdComponent::decRefCount ( const hid_t  obj_id) const

◆ decRefCount() [2/2]

void H5::IdComponent::decRefCount ( ) const

◆ fromClass()

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

◆ getCounter() [1/2]

int H5::IdComponent::getCounter ( const hid_t  obj_id) const

◆ getCounter() [2/2]

int H5::IdComponent::getCounter ( ) const

◆ getHDFObjType() [1/2]

static H5I_type_t H5::IdComponent::getHDFObjType ( const hid_t  obj_id)
static

◆ getHDFObjType() [2/2]

H5I_type_t H5::IdComponent::getHDFObjType ( ) const

◆ getId()

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

◆ incRefCount() [1/2]

void H5::IdComponent::incRefCount ( const hid_t  obj_id) const

◆ incRefCount() [2/2]

void H5::IdComponent::incRefCount ( ) const

◆ inMemFunc()

H5std_string H5::IdComponent::inMemFunc ( const char *  func_name) const

◆ isValid()

static bool H5::IdComponent::isValid ( hid_t  an_id)
static

◆ operator=()

IdComponent& H5::IdComponent::operator= ( const IdComponent rhs)

◆ p_get_file_name()

H5std_string H5::IdComponent::p_get_file_name ( ) const
protected

◆ p_setId()

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

◆ p_valid_id()

static bool H5::IdComponent::p_valid_id ( const hid_t  obj_id)
staticprotected

◆ setId()

void H5::IdComponent::setId ( const hid_t  new_id)

◆ throwException()

virtual void H5::IdComponent::throwException ( const H5std_string func_name,
const H5std_string msg 
) const
inlinevirtual

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

Definition at line 77 of file H5IdComponent.h.

Field Documentation

◆ H5cppinit

bool H5::IdComponent::H5cppinit
staticprivate

Definition at line 118 of file H5IdComponent.h.

◆ H5dontAtexit_called

bool H5::IdComponent::H5dontAtexit_called
staticprotected

Definition at line 113 of file H5IdComponent.h.


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