MXADataSource Class Reference

This class holds the information needed to read data from a source and store that data into the underlying data storage for the MXA Data Model (HDF5 or XML). More...

Inherits IDataSource.

Inheritance diagram for MXADataSource:

Inheritance graph
[legend]
Collaboration diagram for MXADataSource:

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::vector< Pointer > Container

Public Member Functions

 MXA_SHARED_POINTERS (MXADataSource)
 MXA_TYPE_MACRO (MXADataSource)
 MXADataSource ()
 Empty Constructor.
virtual ~MXADataSource ()
 Empty Destructor.
std::string generateInternalPath ()
 Generates the internal path that is used by the underlying data storage mechanism to place the data into the hierarchy.
std::string generateInternalPath (std::vector< int32 > &indices)
 Generates the internal path that is used by the underlying data storage mechanism to place the data into the hierarchy.
void setDataRecord (IDataRecord::Pointer dataRecord)
 Set the value of _dataRecord.
IDataRecord::Pointer getDataRecord ()
 Get the value of _dataRecord.
void setSourcePath (std::string sourcePath)
 Set the value of _sourcePath.
std::string getSourcePath ()
 Get the value of _sourcePath.
bool dataSourceExists ()
 Does the datasource exist on the filesystem.
void setImportDelegate (IImportDelegate::Pointer dataParser)
 Set the value of _importDelegate.
IImportDelegate::Pointer getImportDelegate ()
 Get the value of _importDelegate.
void setDataModel (IDataModel::Pointer dataModel)
 Set the value of mdataModel.
IDataModel::Pointer getDataModel ()
 Get the value of _dataModel.
void setDimensionValues (std::vector< int32 > new_var)
 Set the value of _dimensionValues.
std::vector< int32 > getDimensionValues ()
 Get the value of m_dimensionValues.

Private Member Functions

 MXADataSource (const MXADataSource &)
void operator= (const MXADataSource &)

Private Attributes

IDataRecord::Pointer _dataRecord
std::string _sourcePath
IImportDelegate::Pointer _dataImportDelegate
IDataModel::Pointer _dataModel
std::vector< int32 > _dimensionValues

Detailed Description

This class holds the information needed to read data from a source and store that data into the underlying data storage for the MXA Data Model (HDF5 or XML).

Version:
Revision
1.2


Member Typedef Documentation

typedef std::vector<Pointer> MXADataSource::Container


Constructor & Destructor Documentation

MXADataSource::MXADataSource (  ) 

Empty Constructor.

MXADataSource::~MXADataSource (  )  [virtual]

Empty Destructor.

MXADataSource::MXADataSource ( const MXADataSource  )  [private]


Member Function Documentation

MXADataSource::MXA_SHARED_POINTERS ( MXADataSource   ) 

MXADataSource::MXA_TYPE_MACRO ( MXADataSource   ) 

std::string MXADataSource::generateInternalPath (  )  [virtual]

Generates the internal path that is used by the underlying data storage mechanism to place the data into the hierarchy.

Returns:
std::string

Implements IDataSource.

std::string MXADataSource::generateInternalPath ( std::vector< int32 > &  indices  )  [virtual]

Generates the internal path that is used by the underlying data storage mechanism to place the data into the hierarchy.

Parameters:
indices A new set of indices to use to generate the paths
Returns:
The generated internal path. Empty if there was an error.

Implements IDataSource.

void MXADataSource::setDataRecord ( IDataRecord::Pointer  dataRecord  )  [virtual]

Set the value of _dataRecord.

Parameters:
dataRecord the new value of _dataRecord

Implements IDataSource.

IDataRecord::Pointer MXADataSource::getDataRecord (  )  [virtual]

Get the value of _dataRecord.

Returns:
the value of _dataRecord

Implements IDataSource.

void MXADataSource::setSourcePath ( std::string  sourcePath  )  [virtual]

Set the value of _sourcePath.

Parameters:
sourcePath the new value of _sourcePath

Implements IDataSource.

std::string MXADataSource::getSourcePath (  )  [virtual]

Get the value of _sourcePath.

Returns:
the value of _sourcePath

Implements IDataSource.

bool MXADataSource::dataSourceExists (  )  [virtual]

Does the datasource exist on the filesystem.

Returns:
true if it does exist.

Implements IDataSource.

void MXADataSource::setImportDelegate ( IImportDelegate::Pointer  dataParser  )  [virtual]

Set the value of _importDelegate.

Parameters:
dataParser the new value of _importDelegate

Implements IDataSource.

IImportDelegate::Pointer MXADataSource::getImportDelegate (  )  [virtual]

Get the value of _importDelegate.

Returns:
the value of _importDelegate

Implements IDataSource.

void MXADataSource::setDataModel ( IDataModel::Pointer  dataModel  )  [virtual]

Set the value of mdataModel.

Parameters:
dataModel the new value of _dataModel

Implements IDataSource.

IDataModel::Pointer MXADataSource::getDataModel (  )  [virtual]

Get the value of _dataModel.

Returns:
the value of _dataModel

Implements IDataSource.

void MXADataSource::setDimensionValues ( std::vector< int32 >  new_var  )  [virtual]

Set the value of _dimensionValues.

Parameters:
new_var the new value of _dimensionValues

Implements IDataSource.

std::vector< int32 > MXADataSource::getDimensionValues (  )  [virtual]

Get the value of m_dimensionValues.

Returns:
the value of m_dimensionValues

Implements IDataSource.

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


Member Data Documentation

IDataRecord::Pointer MXADataSource::_dataRecord [private]

std::string MXADataSource::_sourcePath [private]

IImportDelegate::Pointer MXADataSource::_dataImportDelegate [private]

IDataModel::Pointer MXADataSource::_dataModel [private]

std::vector<int32> MXADataSource::_dimensionValues [private]


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