Hdf4Dataset Class Reference

#include <Hdf4Dataset.h>

Inheritance diagram for Hdf4Dataset:

List of all members.

Public Types
enum	HdfTypeEnum {   INT1SBYTE = 0, INT1UBYTE = 1, INT2SBYTES = 2, INT2UBYTES = 3,   INT4SCOMPLEX = 4, INT4SBYTES = 5, INT4UBYTES = 6, FLT4BYTES = 7,   FLT8COMPLEX = 8, FLT8BYTES = 9, STRING = 10, COMPOUND = 11,   UNSUPPORTED = 12 }
typedef EnumWrapper< HdfTypeEnum >	HdfType
Public Member Functions
virtual bool	isCompoundDataset () const
virtual void	setDataEncoding (HdfType dataType)
virtual void	getDataEncoding (EncodingType &encoding) const
virtual void	getDataEncoding (HdfType &type) const
virtual void	setBytesPerElement (size_t sz)
virtual size_t	getBytesPerElement () const
virtual void	setCount (size_t count)
virtual size_t	getCount () const
Protected Member Functions
	Hdf4Dataset (const std::string &name)
virtual	~Hdf4Dataset ()

---

Detailed Description

Definition at line 19 of file Hdf4Dataset.h.

---

Member Typedef Documentation

typedef EnumWrapper<HdfTypeEnum> Hdf4Dataset::HdfType

The EnumWrapper contains a given enum value and provides a isValid() method which returns true if the contained enum value is valid.

Please see How To Use EnumWrapper for more information. The wrapped enum values are Hdf4Dataset::HdfTypeEnum.

Definition at line 45 of file Hdf4Dataset.h.

---

Member Enumeration Documentation

enum Hdf4Dataset::HdfTypeEnum

Types supported by HdfPlugInLib.

Enumerator:

INT1SBYTE	char
INT1UBYTE	unsigned char
INT2SBYTES	short
INT2UBYTES	unsigned short
INT4SCOMPLEX	complex short
INT4SBYTES	int
INT4UBYTES	unsigned int
FLT4BYTES	float
FLT8COMPLEX	complex float
FLT8BYTES	double
STRING	std::string
COMPOUND	Compund or VDATA dataset.
UNSUPPORTED	Indicates a value unsupported by HdfPlugInLib.

Definition at line 25 of file Hdf4Dataset.h.

---

Constructor & Destructor Documentation

Hdf4Dataset::Hdf4Dataset

(

const std::string &

name

)

[explicit, protected]

Creates an Hdf4Dataset object that represents the data set object of an HDF file.

To create a dataset, use Hdf4Group::addDataset().

virtual Hdf4Dataset::~Hdf4Dataset

(

)

[protected, virtual]

Destroys the Hdf4Dataset object.

To destroy an Hdf4Dataset from a group, call Hdf4Group::removeDataset().

---

Member Function Documentation

virtual bool Hdf4Dataset::isCompoundDataset

(

)

const [virtual]

Gets whether the dataset is compound or not.

Compound datasets have no data encoding , 0 per element, and 0 count. If this function returns true, HdfPlugInLib will not have parsed the dataset because the HdfPlugInLib does not support loading compound datasets.

Returns:

Returns whether the dataset is a compound dataset (ie. vdata) or not.

virtual void Hdf4Dataset::setDataEncoding

(

HdfType

dataType

)

[virtual]

Sets the data type for the HDF dataset.

For non-native types or compound datasets, returns UNSUPPORTED.

Parameters:

dataType

The HdfType that corresponds to dataset's type. For those types that do not correspond to an HdfType, UNSUPPORTED should be passed in.

virtual void Hdf4Dataset::getDataEncoding

(

EncodingType &

encoding

)

const [virtual]

Gets the data encoding type for the HDF dataset.

For non-native types or compound datasets, dataType will not be valid (dataType.isValid()).

Parameters:

encoding

The data encoding type that corresponds to the member string. For those types that do not correspond to an EncodingType (ie. a compound dataset), the dataType will not be valid (dataType.isValid()).

virtual void Hdf4Dataset::getDataEncoding

(

HdfType &

type

)

const [virtual]

Gets the HDF data type for the HDF dataset.

For unsupported types or compound datasets, returns UNSUPPORTED.

Parameters:

type

The data type that corresponds to the member string. For those types that do not correspond to an HdfType (ie. a compound dataset), UNSUPPORTED is returned.

virtual void Hdf4Dataset::setBytesPerElement

(

size_t

sz

)

[virtual]

virtual size_t Hdf4Dataset::getBytesPerElement

(

)

const [virtual]

Returns the number of bytes per element of the dataset.

Returns:

The total number of bytes per element of the dataset.

virtual void Hdf4Dataset::setCount

(

size_t

count

)

[virtual]

virtual size_t Hdf4Dataset::getCount

(

)

const [virtual]

Returns the total number of elements in the dataset - even if it is multi-dimensional.

Returns:

The total number of elements in the dataset.