HDF5 C++ API  1.10.1
 All Classes Namespaces Functions Variables Typedefs Friends Pages
Public Member Functions | Protected Member Functions | List of all members
H5::AbstractDs Class Referenceabstract

AbstractDs is an abstract base class, inherited by Attribute and DataSet. More...

#include <H5AbstractDs.h>

Inheritance diagram for H5::AbstractDs:
H5::Attribute H5::DataSet

Public Member Functions

DataType getDataType () const
 Returns the generic datatype of this abstract dataset, which can be a dataset or an attribute. More...
 
ArrayType getArrayType () const
 Returns the array datatype of this abstract dataset which can be a dataset or an attribute. More...
 
CompType getCompType () const
 Returns the compound datatype of this abstract dataset which can be a dataset or an attribute. More...
 
EnumType getEnumType () const
 Returns the enumeration datatype of this abstract dataset which can be a dataset or an attribute. More...
 
IntType getIntType () const
 Returns the integer datatype of this abstract dataset which can be a dataset or an attribute. More...
 
FloatType getFloatType () const
 Returns the floating-point datatype of this abstract dataset, which can be a dataset or an attribute. More...
 
StrType getStrType () const
 Returns the string datatype of this abstract dataset which can be a dataset or an attribute. More...
 
VarLenType getVarLenType () const
 Returns the floating-point datatype of this abstract dataset, which can be a dataset or an attribute. More...
 
virtual size_t getInMemDataSize () const =0
 Gets the size in memory of this abstract dataset. More...
 
virtual DataSpace getSpace () const =0
 Gets the dataspace of this abstract dataset - pure virtual. More...
 
H5T_class_t getTypeClass () const
 Creates an AbstractDs instance using an existing id. More...
 
virtual hsize_t getStorageSize () const =0
 Returns the amount of storage size required - pure virtual. More...
 
virtual H5std_string fromClass () const =0
 
virtual ~AbstractDs ()
 Noop destructor. More...
 

Protected Member Functions

 AbstractDs ()
 Default constructor. More...
 

Detailed Description

It provides a collection of services that are common to both Attribute and DataSet. AbstractDs inherits from H5Object.

Constructor & Destructor Documentation

H5::AbstractDs::~AbstractDs ( )
virtual
H5::AbstractDs::AbstractDs ( )
protected

Member Function Documentation

virtual H5std_string H5::AbstractDs::fromClass ( ) const
pure virtual

Implemented in H5::DataSet, and H5::Attribute.

Referenced by getTypeClass().

ArrayType H5::AbstractDs::getArrayType ( ) const
Returns
ArrayType instance
Exceptions
H5::DataTypeIException

References H5::Exception::getDetailMsg().

CompType H5::AbstractDs::getCompType ( ) const
Returns
CompType instance
Exceptions
H5::DataTypeIException

References H5::Exception::getDetailMsg().

DataType H5::AbstractDs::getDataType ( ) const
Returns
DataType instance
Exceptions
H5::DataTypeIException

References H5::Exception::getDetailMsg().

EnumType H5::AbstractDs::getEnumType ( ) const
Returns
EnumType instance
Exceptions
H5::DataTypeIException

References H5::Exception::getDetailMsg().

FloatType H5::AbstractDs::getFloatType ( ) const
Returns
FloatType instance
Exceptions
H5::DataTypeIException

References H5::Exception::getDetailMsg().

virtual size_t H5::AbstractDs::getInMemDataSize ( ) const
pure virtual

Implemented in H5::DataSet, and H5::Attribute.

IntType H5::AbstractDs::getIntType ( ) const
Returns
IntType instance
Exceptions
H5::DataTypeIException
Examples:
readdata.cpp.

References H5::Exception::getDetailMsg().

virtual DataSpace H5::AbstractDs::getSpace ( ) const
pure virtual

Implemented in H5::Attribute, and H5::DataSet.

virtual hsize_t H5::AbstractDs::getStorageSize ( ) const
pure virtual

Implemented in H5::DataSet, and H5::Attribute.

StrType H5::AbstractDs::getStrType ( ) const
Returns
StrType instance
Exceptions
H5::DataTypeIException

References H5::Exception::getDetailMsg().

H5T_class_t H5::AbstractDs::getTypeClass ( ) const

Returns the class of the datatype that is used by this object, which can be a dataset or an attribute.

Returns
Datatype class identifier
Exceptions
H5::DataTypeIException
Examples:
readdata.cpp.

References fromClass(), and H5::Exception::getDetailMsg().

VarLenType H5::AbstractDs::getVarLenType ( ) const
Returns
VarLenType instance
Exceptions
H5::DataTypeIException

References H5::Exception::getDetailMsg().


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


The HDF Group Help Desk:
  Copyright by The HDF Group
and the Board of Trustees of the University of Illinois