Definition at line 43 of file CPresetIO.hpp.
Exponent::IO::CPresetIO::CPresetIO | ( | ) |
Construction
virtual Exponent::IO::CPresetIO::~CPresetIO | ( | ) | [virtual] |
Destruction
void Exponent::IO::CPresetIO::close | ( | ) |
Close the file (immediate close, no checking)
bool Exponent::IO::CPresetIO::close | ( | const CString & | pluginName | ) |
Close the file
pluginName | A descriptive string that is used to identify the type of preset format |
bool | True if closed properly, false otherwise |
bool Exponent::IO::CPresetIO::closeBodyChunk | ( | ) |
Close the body chunk
bool | True if body tag closed, false otherwise |
bool Exponent::IO::CPresetIO::closeHeadChunk | ( | ) |
Close the head chunk
bool | True if head tag closed, false otherwise |
void Exponent::IO::CPresetIO::constructCloseTag | ( | CString & | closeTag, | |
const CString & | tag | |||
) | [protected] |
Get a close tag - converts 'text' to '<\/text>'
closeTag | On return filled with the tag | |
tag | The tag to make in to a closing tag |
void Exponent::IO::CPresetIO::constructOpenTag | ( | CString & | openTag, | |
const CString & | tag | |||
) | [protected] |
Get an open tag - converts 'text' to '<\/text>'
openTag | On return filled with the tag | |
tag | The tag to make in to an open tag |
CTextStream& Exponent::IO::CPresetIO::getTextStream | ( | ) | [inline] |
Get the stream
CTextStream | & The text stream |
Definition at line 229 of file CPresetIO.hpp.
References m_stream.
bool Exponent::IO::CPresetIO::open | ( | const CTextStream::EStreamMode | streamMode, | |
const CString & | pluginName, | |||
const CSystemString & | presetPath | |||
) |
Open for writing
streamMode | The mode of io | |
pluginName | A descriptive string that is used to identify the type of preset format | |
presetPath | The path to the preset to read / write |
bool | True if opened properly, false otherwise |
bool Exponent::IO::CPresetIO::openBodyChunk | ( | ) |
Open the body chunk
bool | True if read opening body flag correctly, false otherwise |
bool Exponent::IO::CPresetIO::openHeadChunk | ( | ) |
Open the head chunk
bool | True if read opening head flag correctly, false otherwise |
bool Exponent::IO::CPresetIO::readChunkToDoubles | ( | const CString & | tag, | |
const long | sizeOfChunk, | |||
double * | buffer | |||
) |
Read a chunk to doubles
tag | A descriptive chunk tag expected | |
sizeOfChunk | The size of the chunk to write in elements | |
buffer | The buffer to fill |
bool | True if read correctly, false otherwise |
bool Exponent::IO::CPresetIO::readChunkToLongs | ( | const CString & | tag, | |
const long | sizeOfChunk, | |||
long * | buffer | |||
) |
Read a chunk to longs
tag | A descriptive chunk tag expected | |
sizeOfChunk | The size of the chunk to write in elements | |
buffer | The buffer to fill |
bool | True if read correctly, false otherwise |
bool Exponent::IO::CPresetIO::readChunkToStrings | ( | const CString & | tag, | |
TStringCountedPointerArray & | array | |||
) |
Read a chunk to strings
tag | A descriptive chunk tag expected | |
array | Array to store strings contained within the chunk |
bool | True if read the chunk properly, false otherwise |
bool Exponent::IO::CPresetIO::readCloseTag | ( | const CString & | tag | ) | [protected] |
Read a close tag
tag | The tag to read (doesnt need to be surrounded by <\/ >) |
bool | True if read properly, false otherwise |
bool Exponent::IO::CPresetIO::readHeadChunk | ( | TStringCountedPointerArray & | array | ) |
Read head chunk
array | Array to store strings contained within the head chunk |
bool | True if read correctly, false on error |
bool Exponent::IO::CPresetIO::readOpenTag | ( | const CString & | tag | ) | [protected] |
Read an opening tag
tag | The tag to read (doesnt need to be surrounded by < >) |
bool | True if read properly, false otherwise |
bool Exponent::IO::CPresetIO::readParameterChunk | ( | const long | numberOfParameters, | |
double * | parameters | |||
) |
Read the parameters as a chunk of doubles
numberOfParameters | The size of the array to read in | |
parameters | On return is filled with the parameters as read from disk |
bool | True if parameters read correctly |
bool Exponent::IO::CPresetIO::readVersionNumber | ( | const long * | expectedVersion, | |
const long | numberOfVersions, | |||
long & | actualVersion | |||
) |
Read the version number
expectedVersion | The version number you expect to find | |
numberOfVersions | The size of expected versions | |
actualVersion | On return is filled with the version number or undefined on error |
bool | True if versions match, false otherwise |
bool Exponent::IO::CPresetIO::readVersionNumber | ( | const long | expectedVersion | ) |
Read the version number
expectedVersion | The version number you expect to find |
bool | True if versions match, false otherwise |
bool Exponent::IO::CPresetIO::writeChunkToDoubles | ( | const CString & | tag, | |
const long | sizeOfChunk, | |||
const double * | buffer | |||
) |
Write chunk to doubles
tag | A descriptive chunk tag | |
sizeOfChunk | The number of elements to write | |
buffer | The buffer to write |
bool | True if written correctly, false otherwise |
bool Exponent::IO::CPresetIO::writeChunkToLongs | ( | const CString & | tag, | |
const long | sizeOfChunk, | |||
long * | buffer | |||
) |
Write chunk to longs
tag | A descriptive chunk tag | |
sizeOfChunk | The number of elements to write | |
buffer | The buffer to write |
bool | True if written correctly, false otherwise |
bool Exponent::IO::CPresetIO::writeChunkToStrings | ( | const CString & | tag, | |
TStringCountedPointerArray & | array | |||
) |
Write chunk to strings
tag | A descriptive chunk tag | |
array | The array of strings to write |
bool | True if written correctly, false otherwise |
bool Exponent::IO::CPresetIO::writeCloseTag | ( | const CString & | tag | ) | [protected] |
Write a close tag - adds </ before the tag and > at the end of the tag
bool | True if written properly, false otherwise |
bool Exponent::IO::CPresetIO::writeHeadChunk | ( | TStringCountedPointerArray & | array | ) |
Write head chunk
array | The array of strings to write to the head chunk |
bool | True if written correctly, false otherwise |
bool Exponent::IO::CPresetIO::writeOpenTag | ( | const CString & | tag | ) | [protected] |
Write an opening tag - adds < before the tag and > at the end of the tag
tag | The tag to write |
bool | True if written properly, false otherwise |
bool Exponent::IO::CPresetIO::writeParameterChunk | ( | const long | numberOfParameters, | |
const double * | parameters | |||
) |
Write the parameters
numberOfParameters | The number of parameters to write | |
parameters | The parameters to write |
bool | True if written correctly, false otherwise |
bool Exponent::IO::CPresetIO::writeVersionNumber | ( | const long | number | ) |
Write the version number
number | The version number |
bool | True if read correctly, false otherwise |
bool Exponent::IO::CPresetIO::m_isOpenForRead [protected] |
Can we read
Definition at line 286 of file CPresetIO.hpp.
bool Exponent::IO::CPresetIO::m_isOpenForWrite [protected] |
Can we write
Definition at line 287 of file CPresetIO.hpp.
CTextStream Exponent::IO::CPresetIO::m_stream [protected] |
The actual output stream
Definition at line 284 of file CPresetIO.hpp.
Referenced by getTextStream().