IDataModelWriter Class Reference

Abstract class that formally defines the interface that subclasses must implement to be able to write data models to files or other media. More...

Inherited by H5DataModelWriter, and XMLDataModelWriter.

Inheritance diagram for IDataModelWriter:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 IDataModelWriter (IFileIODelegate::Pointer ioDelegate, IDataModel::Pointer dataModel)
virtual ~IDataModelWriter ()
virtual int32 writeModelToFile (int32 fileId)=0
 writes the model to the given file
virtual int32 writeDataModelTemplate (int32 uniqueId)=0
 
Parameters:
uniqueId The unique ID of a file on the underlying filesystem

virtual int32 writeDataDimensions (int32 uniqueId)=0
 
Parameters:
uniqueId The unique ID of a file on the underlying filesystem

virtual int32 writeDataRecords (int32 uniqueId)=0
 
Parameters:
uniqueId The unique ID of a file on the underlying filesystem

virtual int32 writeRequiredMetaData (int32 uniqueId)=0
 
Parameters:
uniqueId The unique ID of a file on the underlying filesystem

virtual int32 writeUserMetaData (int32 uniqueId)=0
 
Parameters:
uniqueId The unique ID of a file on the underlying filesystem

virtual int32 writeSupportFiles (int32 uniqueId)=0
 Writes the support files to the hdf5 data file.

Protected Member Functions

 IDataModelWriter ()

Private Member Functions

 IDataModelWriter (const IDataModelWriter &)
void operator= (const IDataModelWriter &)

Detailed Description

Abstract class that formally defines the interface that subclasses must implement to be able to write data models to files or other media.

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


Constructor & Destructor Documentation

IDataModelWriter::IDataModelWriter ( IFileIODelegate::Pointer  ioDelegate,
IDataModel::Pointer  dataModel 
) [inline]

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

IDataModelWriter::IDataModelWriter (  )  [inline, protected]

IDataModelWriter::IDataModelWriter ( const IDataModelWriter  )  [private]


Member Function Documentation

virtual int32 IDataModelWriter::writeModelToFile ( int32  fileId  )  [pure virtual]

writes the model to the given file

Parameters:
fileId The unique ID of a file on the underlying filesystem
Returns:
If the write was successful

Implemented in XMLDataModelWriter.

virtual int32 IDataModelWriter::writeDataModelTemplate ( int32  uniqueId  )  [pure virtual]

Parameters:
uniqueId The unique ID of a file on the underlying filesystem

Returns:
If the write was successful

Implemented in XMLDataModelWriter.

virtual int32 IDataModelWriter::writeDataDimensions ( int32  uniqueId  )  [pure virtual]

Parameters:
uniqueId The unique ID of a file on the underlying filesystem

Returns:
If the write was successful

Implemented in XMLDataModelWriter.

virtual int32 IDataModelWriter::writeDataRecords ( int32  uniqueId  )  [pure virtual]

Parameters:
uniqueId The unique ID of a file on the underlying filesystem

Returns:
If the write was successful

Implemented in XMLDataModelWriter.

virtual int32 IDataModelWriter::writeRequiredMetaData ( int32  uniqueId  )  [pure virtual]

Parameters:
uniqueId The unique ID of a file on the underlying filesystem

Returns:
If the write was successful

Implemented in XMLDataModelWriter.

virtual int32 IDataModelWriter::writeUserMetaData ( int32  uniqueId  )  [pure virtual]

Parameters:
uniqueId The unique ID of a file on the underlying filesystem

Returns:
If the write was successful

Implemented in XMLDataModelWriter.

virtual int32 IDataModelWriter::writeSupportFiles ( int32  uniqueId  )  [pure virtual]

Writes the support files to the hdf5 data file.

Parameters:
uniqueId HDF5 file id to write to
Returns:
error code

Implemented in XMLDataModelWriter.

void IDataModelWriter::operator= ( const IDataModelWriter  )  [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