H5::AbstractDs Class Reference

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

#include <H5AbstractDs.h>

Inheritance diagram for H5::AbstractDs:

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
	Returns the class of the datatype that is used by this object, which can be a dataset or an attribute. More...
virtual hsize_t	getStorageSize () const =0
	Returns the amount of storage size required - pure virtual. More...
virtual H5std_string	fromClass () const =0
	AbstractDs (const AbstractDs &original)
	Copy constructor: makes a copy of the original AbstractDs object. More...
virtual	~AbstractDs ()
	Noop destructor. More...

Protected Member Functions
	AbstractDs ()
	Default constructor. More...
	AbstractDs (const hid_t ds_id)
	Creates an AbstractDs instance using an existing id. More...

Detailed Description

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

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

Constructor & Destructor Documentation

H5::AbstractDs::AbstractDs

(

const AbstractDs &

original

)

Copy constructor: makes a copy of the original AbstractDs object.

H5::AbstractDs::~AbstractDs ( )

virtual

Noop destructor.

H5::AbstractDs::AbstractDs ( )

protected

Default constructor.

H5::AbstractDs::AbstractDs ( const hid_t  ds_id )

protected

Creates an AbstractDs instance using an existing id.

Member Function Documentation

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

pure virtual

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

ArrayType H5::AbstractDs::getArrayType

(

)

const

Returns the array datatype of this abstract dataset which can be a dataset or an attribute.

Returns

ArrayType instance

Exceptions

H5::DataTypeIException

CompType H5::AbstractDs::getCompType

(

)

const

Returns the compound datatype of this abstract dataset which can be a dataset or an attribute.

Returns

CompType instance

Exceptions

H5::DataTypeIException

DataType H5::AbstractDs::getDataType

(

)

const

Returns the generic datatype of this abstract dataset, which can be a dataset or an attribute.

Returns

DataType instance

Exceptions

H5::DataTypeIException

EnumType H5::AbstractDs::getEnumType

(

)

const

Returns the enumeration datatype of this abstract dataset which can be a dataset or an attribute.

Returns

EnumType instance

Exceptions

H5::DataTypeIException

FloatType H5::AbstractDs::getFloatType

(

)

const

Returns the floating-point datatype of this abstract dataset, which can be a dataset or an attribute.

Returns

FloatType instance

Exceptions

H5::DataTypeIException

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

pure virtual

Gets the size in memory of this abstract dataset.

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

IntType H5::AbstractDs::getIntType

(

)

const

Returns the integer datatype of this abstract dataset which can be a dataset or an attribute.

Returns

IntType instance

Exceptions

H5::DataTypeIException

Examples:

readdata.cpp.

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

pure virtual

Gets the dataspace of this abstract dataset - pure virtual.

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

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

pure virtual

Returns the amount of storage size required - pure virtual.

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

StrType H5::AbstractDs::getStrType

(

)

const

Returns the string datatype of this abstract dataset which can be a dataset or an attribute.

Returns

StrType instance

Exceptions

H5::DataTypeIException

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.

VarLenType H5::AbstractDs::getVarLenType

(

)

const

Returns the floating-point datatype of this abstract dataset, which can be a dataset or an attribute.

Returns

VarLenType instance

Exceptions

H5::DataTypeIException

---

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

• H5AbstractDs.h
• H5AbstractDs.cpp