HdfPager Class Reference

This base class is a raster pager for all HDF files. More...

#include <HdfPager.h>

Inheritance diagram for HdfPager:

List of all members.

Public Member Functions
	HdfPager ()
bool	getInputSpecification (PlugInArgList *&pIn)
Protected Member Functions
bool	parseInputArgs (PlugInArgList *pIn)
const std::string &	getHdfDatasetName () const
virtual void	closeFile ()=0
Static Protected Attributes
static const int	INVALID_HANDLE

---

Detailed Description

This base class is a raster pager for all HDF files.

It provides a specification for HDF4 and HDF5 pagers.

See also:

Hdf4Pager, Hdf5Pager

Definition at line 23 of file HdfPager.h.

---

Constructor & Destructor Documentation

HdfPager::HdfPager

(

)

Creates an HdfPager plug-in.

---

Member Function Documentation

bool HdfPager::getInputSpecification

(

PlugInArgList *&

pIn

)

[virtual]

Creates an input argument list for the HdfAccessor plug-in.

Parameters:

pIn

The input argument list that is created.

Returns:

TRUE if the operation succeeds, FALSE otherwise.

Reimplemented from CachedPager.

bool HdfPager::parseInputArgs

(

PlugInArgList *

pIn

)

[protected, virtual]

Parses and extracts input arguments.

Parameters:

pIn

The argument list to parse. Cannot be NULL.

Returns:

TRUE if the values were properly extracted from the argument list, FALSE otherwise.

Reimplemented from CachedPager.

const std::string& HdfPager::getHdfDatasetName

(

)

const [protected]

Returns the name of the HDF dataset.

The HDF dataset name is one of the input arguments. Gets populated from parseInputArgs(PlugInArgList*).

Returns:

The name of the HDF dataset. For HDF4 data sets, this will be a name. For HDF5 datasets, this will be the full path and name that uniquely identifies the dataset.

virtual void HdfPager::closeFile

(

)

[protected, pure virtual]

Closes the HDF file.

The HDF File is opened in the subclasses.

---

Member Data Documentation

const int HdfPager::INVALID_HANDLE [static, protected]

A constant that represents an invalid handle in all forms of the HDF C API.

Definition at line 45 of file HdfPager.h.