IDataset Class Reference

Pure virtual class that represents a dataset with appropriate attributes so that the data could be written to an underlying data file. Currently HDF5. More...

Inherits IDataFileIO.

Inherited by H5Dataset.

Inheritance diagram for IDataset:

Inheritance graph
[legend]
Collaboration diagram for IDataset:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 IDataset ()
virtual ~IDataset ()
virtual void setDatasetPath (const std::string &path)=0
 Sets the dataset path and name.
virtual std::string getDatasetPath ()=0
 Returns the path+name of the dataset.
virtual void setData (IMXAArray::Pointer data)=0
 Sets the data for the dataset.
virtual IMXAArray::Pointer getData ()=0
 Returns the data for this class.
virtual void addAttribute (const std::string &attributeKey, IMXAArray::Pointer data)=0
 Adds an attribute to this dataset.
virtual void removeAttribute (const std::string &attributeKey)=0
 Removes an attribute from the data set.
virtual IMXAArray::Pointer getAttribute (const std::string &attributeKey)=0
 Returns an attribute or NULL if not found.

Private Member Functions

 IDataset (const IDataset &)
void operator= (const IDataset &)

Detailed Description

Pure virtual class that represents a dataset with appropriate attributes so that the data could be written to an underlying data file. Currently HDF5.

Author:
mjackson
Date:
Jan 3, 2008
Version:
Revision
1.2


Constructor & Destructor Documentation

IDataset::IDataset (  )  [inline]

virtual IDataset::~IDataset (  )  [inline, virtual]

IDataset::IDataset ( const IDataset  )  [private]


Member Function Documentation

virtual void IDataset::setDatasetPath ( const std::string &  path  )  [pure virtual]

Sets the dataset path and name.

Parameters:
path + name of the dataset

Implemented in H5Dataset.

virtual std::string IDataset::getDatasetPath (  )  [pure virtual]

Returns the path+name of the dataset.

Implemented in H5Dataset.

virtual void IDataset::setData ( IMXAArray::Pointer  data  )  [pure virtual]

Sets the data for the dataset.

Parameters:
data Instance of IMXAArray

Implemented in H5Dataset.

virtual IMXAArray::Pointer IDataset::getData (  )  [pure virtual]

Returns the data for this class.

Implemented in H5Dataset.

virtual void IDataset::addAttribute ( const std::string &  attributeKey,
IMXAArray::Pointer  data 
) [pure virtual]

Adds an attribute to this dataset.

Parameters:
attributeKey The name of the attribute
data The data for the attribute

Implemented in H5Dataset.

virtual void IDataset::removeAttribute ( const std::string &  attributeKey  )  [pure virtual]

Removes an attribute from the data set.

Parameters:
attributeKey The name of the attribute to remove

Implemented in H5Dataset.

virtual IMXAArray::Pointer IDataset::getAttribute ( const std::string &  attributeKey  )  [pure virtual]

Returns an attribute or NULL if not found.

Parameters:
attributeKey The name of the attribute to retrieve
Returns:

Implemented in H5Dataset.

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


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