Inherited by H5MXADataFile.
Inheritance diagram for IDataFile:
Public Types | |
typedef boost::shared_ptr< IDataModel > | DataModelType |
typedef boost::shared_ptr< IDataset > | DatasetType |
Public Member Functions | |
MXA_SHARED_POINTERS (IDataFile) | |
IDataFile (const std::string &filename) | |
virtual | ~IDataFile () |
virtual std::string | getFilename ()=0 |
returns the name of the file that is actively being read from or written to. | |
virtual DataModelType | getDataModel ()=0 |
returns the DataModel as read from the data file | |
virtual int32 | createFile ()=0 |
Creates a new data file, first deleting and existing file with the same name. | |
virtual int32 | openFile (bool readOnly)=0 |
Opens an existing data file. | |
virtual int32 | closeFile (bool saveModel)=0 |
Closes the data file. Any further access to the file will fail. | |
virtual float | supportedMXAFileVersion ()=0 |
Checks if the file version of the data file is with in the bounds of the library to read/parse the data model. | |
virtual bool | isFileOpen ()=0 |
Returns if the file is currently in the "open" state. If this file is OPEN then file operations (Read/Write data or model) can be performed on the file. | |
virtual bool | isReadOnly ()=0 |
Was the file opened in ReadOnly mode. | |
virtual int32 | getFileId ()=0 |
Returns the unique identifier for the open file. | |
virtual int32 | saveDataModel ()=0 |
Writes the Data Model into the underlying data file overwriting any existing model. This may have adverse effects on the ability to retrieve data from the data file if the data model differs in structure from the original data model. | |
virtual int32 | writeData (const DatasetType dataset)=0 |
virtual int32 | readData (const DatasetType dataset)=0 |
Private Member Functions | |
IDataFile (const IDataFile &) | |
void | operator= (const IDataFile &) |
typedef boost::shared_ptr<IDataModel> IDataFile::DataModelType |
typedef boost::shared_ptr<IDataset> IDataFile::DatasetType |
IDataFile::IDataFile | ( | const std::string & | filename | ) | [inline, explicit] |
virtual IDataFile::~IDataFile | ( | ) | [inline, virtual] |
IDataFile::IDataFile | ( | const IDataFile & | ) | [private] |
IDataFile::MXA_SHARED_POINTERS | ( | IDataFile | ) |
virtual std::string IDataFile::getFilename | ( | ) | [pure virtual] |
returns the name of the file that is actively being read from or written to.
Implemented in H5MXADataFile.
virtual DataModelType IDataFile::getDataModel | ( | ) | [pure virtual] |
returns the DataModel as read from the data file
Implemented in H5MXADataFile.
virtual int32 IDataFile::createFile | ( | ) | [pure virtual] |
Creates a new data file, first deleting and existing file with the same name.
Implemented in H5MXADataFile.
virtual int32 IDataFile::openFile | ( | bool | readOnly | ) | [pure virtual] |
Opens an existing data file.
readOnly | Open the file in Read-Only Mode |
Implemented in H5MXADataFile.
virtual int32 IDataFile::closeFile | ( | bool | saveModel | ) | [pure virtual] |
Closes the data file. Any further access to the file will fail.
Implemented in H5MXADataFile.
virtual float IDataFile::supportedMXAFileVersion | ( | ) | [pure virtual] |
Checks if the file version of the data file is with in the bounds of the library to read/parse the data model.
Implemented in H5MXADataFile.
virtual bool IDataFile::isFileOpen | ( | ) | [pure virtual] |
Returns if the file is currently in the "open" state. If this file is OPEN then file operations (Read/Write data or model) can be performed on the file.
Implemented in H5MXADataFile.
virtual bool IDataFile::isReadOnly | ( | ) | [pure virtual] |
virtual int32 IDataFile::getFileId | ( | ) | [pure virtual] |
virtual int32 IDataFile::saveDataModel | ( | ) | [pure virtual] |
Writes the Data Model into the underlying data file overwriting any existing model. This may have adverse effects on the ability to retrieve data from the data file if the data model differs in structure from the original data model.
Implemented in H5MXADataFile.
virtual int32 IDataFile::writeData | ( | const DatasetType | dataset | ) | [pure virtual] |
virtual int32 IDataFile::readData | ( | const DatasetType | dataset | ) | [pure virtual] |
void IDataFile::operator= | ( | const IDataFile & | ) | [private] |