 |
VR-Link API Documentation for HLA Evolved
|
|
VR-Link API Documentation for HLA Evolved
|
Instances of DtFedReader are used to read a FED file, and fill in a DtFedTarget with the information read. More...
Inheritance diagram for DtFedReader: Collaboration diagram for DtFedReader:Public Member Functions | |
| DtFedReader () | |
| Constructor. | |
| virtual | ~DtFedReader () |
| Destructor. | |
| virtual DtFedReadStatus | readFed (const char *fedFileName, DtFedTarget *fedTarget, bool strictCheckingEnabled=false, bool useDTD=false, bool dontParseSwitches=false) |
| Read the FED file fedFileName, setting values to fedTarget. | |
| virtual DtFedReadStatus | readFedFilePtr (FILE *fedFilePtr, DtFedTarget *fedTarget, DtFilename filename, bool strictCheckingEnabled=false, bool useDTD=false, bool dontParseSwitches=false) |
| Read the FED file from the FILE*, setting values to fedTarget. | |
| virtual FILE * | openFedFile (const char *fileName, bool isBinary=false) |
| get the a file handle to the FED File for reading in text or binary mode | |
| virtual void | setStrictChecking (bool enable) |
| Set/Get status of strict checking. | |
| virtual bool | strictChecking () const |
| virtual void | setExpectedFomType (DtFomType fomType) |
| Set/Get expected FOM type. | |
| virtual DtFomType | expectedFomType () const |
| virtual DtFomType | lastFomType () const |
| Returns the FOM type of the last FOM read. | |
| virtual const DtString & | lastError () const |
| Get the last error. | |
Protected Member Functions | |
| virtual DtFomType | checkFomType (const char *fedFileName, void *fedFilePtr) const |
| Get the FOM Type. | |
Static Protected Member Functions | |
| static bool | readFileIntoBuffer (FILE *fileHandle, char **fileBuffer, unsigned int *fileSize) |
| Read the file from the FILE* into the buffer. | |
Protected Attributes | |
| DtFedTarget * | myFedTarget |
| DtFedReader * | myChildReader |
| bool | myStrictChecking |
| bool | myDontParseSwitchTable |
| DtFomType | myExpectedFomType |
| When set, the FOM must conform to this type. | |
| DtFomType | myLastFomType |
| The type of FOM format that was last read. | |
| DtString | myLastError |
| Description of last encountered error. | |
Private Member Functions | |
| DtFedReader (const DtFedReader &) | |
| Copy constructor and Assignment operator - Unimplemented. | |
| DtFedReader & | operator= (const DtFedReader &) |
Instances of DtFedReader are used to read a FED file, and fill in a DtFedTarget with the information read.
Base class for contained file format specific (i.e. - mtl and xml) FED file readers
Constructor.
| virtual DtFedReader::~DtFedReader | ( | ) | [virtual] |
Destructor.
| DtFedReader::DtFedReader | ( | const DtFedReader & | ) | [private] |
Copy constructor and Assignment operator - Unimplemented.
| virtual DtFomType DtFedReader::checkFomType | ( | const char * | fedFileName, |
| void * | fedFilePtr | ||
| ) | const [protected, virtual] |
Get the FOM Type.
| virtual DtFomType DtFedReader::expectedFomType | ( | ) | const [virtual] |
| virtual const DtString& DtFedReader::lastError | ( | ) | const [virtual] |
Get the last error.
| virtual DtFomType DtFedReader::lastFomType | ( | ) | const [virtual] |
Returns the FOM type of the last FOM read.
| virtual FILE* DtFedReader::openFedFile | ( | const char * | fileName, |
| bool | isBinary = false |
||
| ) | [virtual] |
get the a file handle to the FED File for reading in text or binary mode
| DtFedReader& DtFedReader::operator= | ( | const DtFedReader & | ) | [private] |
| virtual DtFedReadStatus DtFedReader::readFed | ( | const char * | fedFileName, |
| DtFedTarget * | fedTarget, | ||
| bool | strictCheckingEnabled = false, |
||
| bool | useDTD = false, |
||
| bool | dontParseSwitches = false |
||
| ) | [virtual] |
Read the FED file fedFileName, setting values to fedTarget.
Note if fedTarget is NULL the fedfile will be read and verified only.
| virtual DtFedReadStatus DtFedReader::readFedFilePtr | ( | FILE * | fedFilePtr, |
| DtFedTarget * | fedTarget, | ||
| DtFilename | filename, | ||
| bool | strictCheckingEnabled = false, |
||
| bool | useDTD = false, |
||
| bool | dontParseSwitches = false |
||
| ) | [virtual] |
Read the FED file from the FILE*, setting values to fedTarget.
Note if fedTarget is NULL the fedfile will be read and verified only.
Reimplemented in DtXmlFedReader, DtXmlFedReader1516e, and DtMtlFedReader.
| static bool DtFedReader::readFileIntoBuffer | ( | FILE * | fileHandle, |
| char ** | fileBuffer, | ||
| unsigned int * | fileSize | ||
| ) | [static, protected] |
Read the file from the FILE* into the buffer.
| virtual void DtFedReader::setExpectedFomType | ( | DtFomType | fomType | ) | [virtual] |
Set/Get expected FOM type.
| virtual void DtFedReader::setStrictChecking | ( | bool | enable | ) | [virtual] |
Set/Get status of strict checking.
| virtual bool DtFedReader::strictChecking | ( | ) | const [virtual] |
DtFedReader* DtFedReader::myChildReader [protected] |
bool DtFedReader::myDontParseSwitchTable [protected] |
DtFomType DtFedReader::myExpectedFomType [protected] |
When set, the FOM must conform to this type.
DtFedTarget* DtFedReader::myFedTarget [protected] |
Reimplemented in DtXmlFedReader1516e, DtXmlFedReader, and DtMtlFedReader.
DtString DtFedReader::myLastError [protected] |
Description of last encountered error.
DtFomType DtFedReader::myLastFomType [protected] |
The type of FOM format that was last read.
bool DtFedReader::myStrictChecking [protected] |
