Inherited by MXASupportFile.
Inheritance diagram for ISupportFile:
Public Types | |
typedef std::vector< ISupportFile::Pointer > | Container |
Public Member Functions | |
MXA_SHARED_POINTERS (ISupportFile) | |
ISupportFile () | |
virtual | ~ISupportFile () |
virtual void | setFileSystemPath (const std::string &filesystemPath)=0 |
Sets the path to the file on the local filesystem. | |
virtual std::string | getFileSystemPath ()=0 |
Returns the path to the file on the local filesystem. | |
virtual void | setFileType (const std::string &fileType)=0 |
Sets the File type as a hint for viewers on how to render the file if possible. The default is "Binary". You may also use "Text". | |
virtual std::string | getFileType ()=0 |
Returns the file type. | |
virtual uint8 * | getFilePointer (uint64 offset)=0 |
Returns a pointer to the specified offset in the cached file. Note that if the file has NOT been read then this will return a NULL pointer. | |
virtual uint64 | getFileSize ()=0 |
Returns the size of the file which could be Zero if the file has NOT been read or can not be read. | |
virtual bool | isFileCached ()=0 |
Has the file been read into memory. | |
virtual void | flushCachedFile ()=0 |
If the file is residing in memory, free the memory by unloading the file from memory. | |
virtual int32 | readFromFileSystem ()=0 |
Read from the filesystem and cache the file into memory. Careful when doing this with large files. | |
virtual void | setIndex (int index)=0 |
Sets the internal value used by the MXA API to store the file in teh HDF5 file. | |
virtual int | getIndex ()=0 |
Returns the internal index used by the MXA API to store the file in the HDF5 file. | |
virtual int32 | readFromMXAFile ()=0 |
Reads file contents from the HDF5 file into memory. From this point you can write the file out to the local filesystem if needed. | |
Private Member Functions | |
ISupportFile (const ISupportFile &) | |
void | operator= (const ISupportFile &) |
typedef std::vector<ISupportFile::Pointer> ISupportFile::Container |
ISupportFile::ISupportFile | ( | ) | [inline] |
virtual ISupportFile::~ISupportFile | ( | ) | [inline, virtual] |
ISupportFile::ISupportFile | ( | const ISupportFile & | ) | [private] |
ISupportFile::MXA_SHARED_POINTERS | ( | ISupportFile | ) |
virtual void ISupportFile::setFileSystemPath | ( | const std::string & | filesystemPath | ) | [pure virtual] |
Sets the path to the file on the local filesystem.
filesystemPath | The path to the file on the local filesystem |
Implemented in MXASupportFile.
virtual std::string ISupportFile::getFileSystemPath | ( | ) | [pure virtual] |
virtual void ISupportFile::setFileType | ( | const std::string & | fileType | ) | [pure virtual] |
Sets the File type as a hint for viewers on how to render the file if possible. The default is "Binary". You may also use "Text".
fileType | "Binary" or "Text" |
Implemented in MXASupportFile.
virtual std::string ISupportFile::getFileType | ( | ) | [pure virtual] |
virtual uint8* ISupportFile::getFilePointer | ( | uint64 | offset | ) | [pure virtual] |
Returns a pointer to the specified offset in the cached file. Note that if the file has NOT been read then this will return a NULL pointer.
offset | The offset into the cached file to read. |
Implemented in MXASupportFile.
virtual uint64 ISupportFile::getFileSize | ( | ) | [pure virtual] |
Returns the size of the file which could be Zero if the file has NOT been read or can not be read.
Implemented in MXASupportFile.
virtual bool ISupportFile::isFileCached | ( | ) | [pure virtual] |
virtual void ISupportFile::flushCachedFile | ( | ) | [pure virtual] |
If the file is residing in memory, free the memory by unloading the file from memory.
Implemented in MXASupportFile.
virtual int32 ISupportFile::readFromFileSystem | ( | ) | [pure virtual] |
Read from the filesystem and cache the file into memory. Careful when doing this with large files.
Implemented in MXASupportFile.
virtual void ISupportFile::setIndex | ( | int | index | ) | [pure virtual] |
Sets the internal value used by the MXA API to store the file in teh HDF5 file.
index | The index to use. |
Implemented in MXASupportFile.
virtual int ISupportFile::getIndex | ( | ) | [pure virtual] |
Returns the internal index used by the MXA API to store the file in the HDF5 file.
Implemented in MXASupportFile.
virtual int32 ISupportFile::readFromMXAFile | ( | ) | [pure virtual] |
Reads file contents from the HDF5 file into memory. From this point you can write the file out to the local filesystem if needed.
Implemented in MXASupportFile.
void ISupportFile::operator= | ( | const ISupportFile & | ) | [private] |