H5DataModelReader Class Reference

This class is responsible for the actual reading of the data model from the HDF5 data file. More...

Inherits IDataModelReader.

Inheritance diagram for H5DataModelReader:

Inheritance graph
[legend]
Collaboration diagram for H5DataModelReader:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 H5DataModelReader (IDataModel::Pointer dataModel)
 Constructor for H5DataModelReader.
virtual ~H5DataModelReader ()
herr_t readDataModel (hid_t locId)
 Reads the Data model.
herr_t readModelType (hid_t locId)
 Reads the model type.
herr_t readModelVersion (hid_t locId)
 reads the model version
herr_t readDataRoot (hid_t locId)
 reads the data root
herr_t readDataDimensions (hid_t locId)
 reads the data dimensions
herr_t readDataRecords (hid_t locId)
 reads the data records
herr_t readRequiredMetaData (hid_t locId)
 reads the required meta data
herr_t readUserMetaData (hid_t locId)
 reads the user meta data
herr_t readSupportFiles (hid_t locId)
 reads the support files meta data from the MXA file without actually reading the file data

Protected Member Functions

MXADataDimension::Pointer _loadDataDimension (hid_t locId, std::string name)
 Reads a single Data Dimension from the HDF5 data file.
herr_t _traverseDataRecords (hid_t gid, MXADataRecord::Pointer parent)
 Recursive method that traverses the tree of Data Records.
MXADataRecord::Pointer _loadDataRecord (hid_t gid, std::string name)
 Reads a Data Record from the HDF5 data file.

Private Member Functions

 H5DataModelReader (const H5DataModelReader &)
void operator= (const H5DataModelReader &)

Private Attributes

IDataModel::Pointer _dataModel

Detailed Description

This class is responsible for the actual reading of the data model from the HDF5 data file.

Author:
Mike Jackson
Date:
Mar 2007
Version:
Revision
1.2
H5DataModelReader.h


Constructor & Destructor Documentation

H5DataModelReader::H5DataModelReader ( IDataModel::Pointer  dataModel  ) 

Constructor for H5DataModelReader.

Parameters:
dataModel The DataModel to use. Note that settings in the datamodel will be over written with those from the file.

H5DataModelReader::~H5DataModelReader (  )  [virtual]

H5DataModelReader::H5DataModelReader ( const H5DataModelReader  )  [private]


Member Function Documentation

herr_t H5DataModelReader::readDataModel ( hid_t  locId  ) 

Reads the Data model.

Parameters:
locId The HDF5 file or group id
Returns:
Standard HDF5 Error Condition

herr_t H5DataModelReader::readModelType ( hid_t  locId  ) 

Reads the model type.

Parameters:
locId The HDF5 file or group id
Returns:
Standard HDF5 Error Condition

herr_t H5DataModelReader::readModelVersion ( hid_t  locId  ) 

reads the model version

Parameters:
locId The HDF5 file or group id
Returns:
Standard HDF5 Error Condition

herr_t H5DataModelReader::readDataRoot ( hid_t  locId  ) 

reads the data root

Parameters:
locId The HDF5 file or group id
Returns:
Standard HDF5 Error Condition

herr_t H5DataModelReader::readDataDimensions ( hid_t  locId  ) 

reads the data dimensions

Parameters:
locId The HDF5 file or group id
Returns:
Standard HDF5 Error Condition

herr_t H5DataModelReader::readDataRecords ( hid_t  locId  ) 

reads the data records

Parameters:
locId 
Returns:
Standard HDF5 Error Condition

herr_t H5DataModelReader::readRequiredMetaData ( hid_t  locId  ) 

reads the required meta data

Parameters:
locId The HDF5 file or group id
Returns:
Standard HDF5 Error Condition

herr_t H5DataModelReader::readUserMetaData ( hid_t  locId  ) 

reads the user meta data

Parameters:
locId The HDF5 file or group id
Returns:
Standard HDF5 Error Condition

herr_t H5DataModelReader::readSupportFiles ( hid_t  locId  ) 

reads the support files meta data from the MXA file without actually reading the file data

Parameters:
locId The HDF5 file or group id
Returns:
Standard HDF5 Error Condition

MXADataDimension::Pointer H5DataModelReader::_loadDataDimension ( hid_t  locId,
std::string  name 
) [protected]

Reads a single Data Dimension from the HDF5 data file.

Parameters:
locId The HDF5 file or group id
name The name of the dimension to read
Returns:
IDataDimension Shared Pointer

herr_t H5DataModelReader::_traverseDataRecords ( hid_t  gid,
MXADataRecord::Pointer  parent 
) [protected]

Recursive method that traverses the tree of Data Records.

Parameters:
gid The Group ID
parent The Parent Data Record
Returns:
Standard HDF5 Error Condition

MXADataRecord::Pointer H5DataModelReader::_loadDataRecord ( hid_t  gid,
std::string  name 
) [protected]

Reads a Data Record from the HDF5 data file.

Parameters:
gid The GUID to assign to the Data Record
name The Name of the data record
Returns:
IDataRecord shared pointer

void H5DataModelReader::operator= ( const H5DataModelReader  )  [private]


Member Data Documentation

IDataModel::Pointer H5DataModelReader::_dataModel [private]


The documentation for this class was generated from the following files:
Generated on Tue Nov 17 18:43:12 2009 for MXADataModel by  doxygen 1.5.2