IDataSource Class Reference

Interface that defines the methods of a "Data Source" Object. More...

Inherited by MXADataSource.

Inheritance diagram for IDataSource:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::vector< Pointer > Collection

Public Member Functions

 IDataSource ()
virtual ~IDataSource ()
virtual std::string generateInternalPath ()=0
 Generates the internal path that is used by the underlying data storage mechanism to place the data into the hierarchy.
virtual std::string generateInternalPath (std::vector< int32 > &indices)=0
 Generates the internal path that is used by the underlying data storage mechanism to place the data into the hierarchy.
virtual void setDataRecord (IDataRecord::Pointer dataRecord)=0
virtual IDataRecord::Pointer getDataRecord ()=0
virtual void setSourcePath (std::string sourcePath)=0
virtual std::string getSourcePath ()=0
virtual bool dataSourceExists ()=0
 Does the datasource exist on the filesystem.
virtual void setImportDelegate (IImportDelegate::Pointer dataParser)=0
virtual IImportDelegate::Pointer getImportDelegate ()=0
virtual void setDataModel (IDataModel::Pointer dataModel)=0
virtual IDataModel::Pointer getDataModel ()=0
virtual void setDimensionValues (std::vector< int32 > new_var)=0
virtual std::vector< int32 > getDimensionValues ()=0

Detailed Description

Interface that defines the methods of a "Data Source" Object.

Author:
Mike Jackson
Date:
April 2007
Version:
Revision
1.2


Member Typedef Documentation

typedef std::vector<Pointer> IDataSource::Collection


Constructor & Destructor Documentation

IDataSource::IDataSource (  )  [inline]

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


Member Function Documentation

virtual std::string IDataSource::generateInternalPath (  )  [pure virtual]

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

Returns:
std::string

Implemented in MXADataSource.

virtual std::string IDataSource::generateInternalPath ( std::vector< int32 > &  indices  )  [pure 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.

Implemented in MXADataSource.

virtual void IDataSource::setDataRecord ( IDataRecord::Pointer  dataRecord  )  [pure virtual]

Set the value of m_dataRecord

Parameters:
dataRecord the new value of m_dataRecord

Implemented in MXADataSource.

virtual IDataRecord::Pointer IDataSource::getDataRecord (  )  [pure virtual]

Get the value of m_dataRecord

Returns:
the value of m_dataRecord

Implemented in MXADataSource.

virtual void IDataSource::setSourcePath ( std::string  sourcePath  )  [pure virtual]

Set the value of m_sourcePath

Parameters:
sourcePath the new value of m_sourcePath

Implemented in MXADataSource.

virtual std::string IDataSource::getSourcePath (  )  [pure virtual]

Get the value of m_sourcePath

Returns:
the value of m_sourcePath

Implemented in MXADataSource.

virtual bool IDataSource::dataSourceExists (  )  [pure virtual]

Does the datasource exist on the filesystem.

Returns:
true if it does exist.

Implemented in MXADataSource.

virtual void IDataSource::setImportDelegate ( IImportDelegate::Pointer  dataParser  )  [pure virtual]

Set the value of m_importDelegate

Parameters:
dataParser the new value of m_importDelegate

Implemented in MXADataSource.

virtual IImportDelegate::Pointer IDataSource::getImportDelegate (  )  [pure virtual]

Get the value of m_importDelegate

Returns:
the value of m_importDelegate

Implemented in MXADataSource.

virtual void IDataSource::setDataModel ( IDataModel::Pointer  dataModel  )  [pure virtual]

Set the value of m_dataModel

Parameters:
dataModel the new value of m_dataModel

Implemented in MXADataSource.

virtual IDataModel::Pointer IDataSource::getDataModel (  )  [pure virtual]

Get the value of m_dataModel

Returns:
the value of m_dataModel

Implemented in MXADataSource.

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

Set the value of m_dimensionValues

Parameters:
new_var the new value of m_dimensionValues

Implemented in MXADataSource.

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

Get the value of m_dimensionValues

Returns:
the value of m_dimensionValues

Implemented in MXADataSource.


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