VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Private Member Functions

Instances of DtFedReader1516 are used to read a FED file, and fill in a DtFedTarget with the information read. More...

+ Inheritance diagram for DtFedReader1516:
+ Collaboration diagram for DtFedReader1516:

Public Member Functions

 DtFedReader1516 ()
 
virtual ~DtFedReader1516 ()
 
virtual bool dtdValidate (xmlDoc *pDoc, const char *dtdFile)
 Validate the file against the given DTD. More...
 
virtual DtFedReadStatus readFedFilePtr (FILE *filePointer, DtFedTarget *fedTarget, DtFilename fileName, unsigned int strictCheckingMask=DtFedReadStrictDisabled, bool useDTD=false, bool dontParseSwitches=false)
 Read the FED file fedFileName, setting values to fedTarget. More...
 
virtual DtFedReadStatus processXmlDocPtr (xmlDocPtr xmlDocument)
 
virtual DtFedReadStatus parseTimeTree (xmlNode *currentNode)
 
virtual DtFedReadStatus parseSynchronizationsTree (xmlNode *currentNode)
 
virtual DtFedReadStatus getSharingType (xmlNode *currentNode, DtSharingType &sharingType)
 
virtual DtFedReadStatus getSemantics (xmlNode *currentNode, DtString &semanticsVal)
 
virtual DtFedReadStatus getNotes (xmlNode *currentNode, DtString &notesVal)
 
virtual DtFedReadStatus getOwnershipType (xmlNode *currentNode, DtOwnershipType &ownershipVal)
 
virtual DtFedReadStatus getUpdateCondition (xmlNode *currentNode, DtString &updateConditionVal)
 
virtual DtFedReadStatus getUpdateType (xmlNode *currentNode, DtFomUpdateType &updateTypeVal)
 
virtual DtFedReadStatus processFed (xmlNode *fedObj)
 process the FED directive More...
 
virtual DtFedReadStatus parseTransportationsList (xmlNode *currentNode)
 process the transportations directive (We need to override parseTransportationsList because VRL has a static list of transport types.) More...
 
virtual DtFedReadStatus processObjects (xmlNode *currentNode)
 process the Objects directive More...
 
virtual DtFedReadStatus processInteractions (xmlNode *currentNode)
 process the Interactions directive More...
 
virtual DtFedReadStatus parseObjectTree (xmlNode *currentNode, const DtString &parentName)
 process the list object of classes More...
 
virtual DtFedReadStatus parseAttribute (xmlNode *currentNode, const DtString &parentName)
 process an attribute of an object class More...
 
virtual DtFedReadStatus parseAttributeDimensions (xmlNode *currentNode, DtString const &objectClass, DtString const &attribute)
 process attribute dimension associations More...
 
virtual DtFedReadStatus parseInteractionTree (xmlNode *currentNode, const DtString &parentName)
 process the list of interaction classes More...
 
virtual DtFedReadStatus parseInteractionDimensions (xmlNode *currentNode, DtString const &interactionClass)
 process attribute dimension associations More...
 
virtual DtFedReadStatus parseDimensionList (xmlNode *currentNode)
 process the list of dimensions More...
 
virtual DtFedReadStatus parseDimension (xmlNode *currentNode)
 process a dimension More...
 
virtual DtFedReadStatus parseSwitches (xmlNode *currentNode)
 process switches More...
 
virtual DtFedReadStatus parseParameter (xmlNode *currentNode, const DtString &parentName)
 process a parameter of an interaction class More...
 
virtual DtFedReadStatus parseDataTypeTree (xmlNode *currentNode)
 process the list of datatype classes More...
 
virtual DtFedReadStatus parseNotesTree (xmlNode *currentNode)
 process the list of notes classes More...
 
virtual DtFedReadStatus parseTagsTree (xmlNode *currentNode)
 process the list of user defined tags. More...
 
virtual DtFedReadStatus parseBasicDataTypesTree (xmlNode *currentNode)
 process the list of basic data representations More...
 
virtual DtFedReadStatus parseSimpleDataTypesTree (xmlNode *currentNode)
 process the list of simple data types More...
 
virtual DtFedReadStatus parseArrayDataTypesTree (xmlNode *currentNode)
 process the list of array data types More...
 
virtual DtFedReadStatus parseEnumeratedDataTypesTree (xmlNode *currentNode)
 process the list of enumerated data types More...
 
virtual DtFedReadStatus parseFixedRecordDataTypesTree (xmlNode *currentNode)
 process the list of fixed record data types More...
 
virtual DtFedReadStatus parseVariantRecordDataTypesTree (xmlNode *currentNode)
 process the list of variant record data types More...
 
virtual DtFedReadStatus getTransportType (xmlNode *currentNode, DtTransportType &transportType)
 get the data for the Transportation attribute of the current node More...
 
virtual DtFedReadStatus getOrderType (xmlNode *currentNode, DtOrderType &orderType)
 get the data for the Order attribute of the current node More...
 
- Public Member Functions inherited from DtXmlFedReader
 DtXmlFedReader ()
 Constructor. More...
 
virtual ~DtXmlFedReader ()
 Destructor. More...
 
- Public Member Functions inherited from DtFedReader
 DtFedReader ()
 Constructor. More...
 
virtual ~DtFedReader ()
 Destructor. More...
 
virtual DtFedReadStatus readFed (const char *fedFileName, DtFedTarget *fedTarget, unsigned int strictCheckingMask=DtFedReadStrictDisabled, bool useDTD=false, bool dontParseSwitches=false)
 Read the FED file fedFileName, setting values to fedTarget. More...
 
virtual FILE * openFedFileWithErrCheck (const char *fileName, bool isBinary=false)
 get the a file handle to the FED File for reading in text or binary mode More...
 
virtual unsigned int setStrictChecking (unsigned int checkMask)
 Set status of strict checking. More...
 
virtual bool strictChecking (unsigned int checkMask) const
 Returns bool: strictChecking enabled for types of checks provided. More...
 
virtual void setExpectedFomType (DtFomType fomType)
 Set/Get expected FOM type. More...
 
virtual DtFomType expectedFomType () const
 
virtual DtFomType lastFomType () const
 Returns the FOM type of the last FOM read. More...
 
virtual const DtStringlastError () const
 Get the last error. More...
 
char * takeCurrFddData ()
 

Protected Attributes

bool myReplacedObjectRoot
 Indicates when federation's FOM is 1.3 and root name has been replaced to match. More...
 
bool myReplacedInteractionRoot
 Indicates when federation's FOM is 1.3 and root name has been replaced to match. More...
 
- Protected Attributes inherited from DtXmlFedReader
DtFedTargetmyFedTarget
 
DtFilename myFileBeingRead
 
- Protected Attributes inherited from DtFedReader
DtFedTargetmyFedTarget
 
DtFedReadermyChildReader
 
unsigned int myStrictChecking
 
bool myDontParseSwitchTable
 
DtFomType myExpectedFomType
 When set, the FOM must conform to this type. More...
 
DtFomType myLastFomType
 The type of FOM format that was last read. More...
 
DtString myLastError
 Description of last encountered error. More...
 

Private Member Functions

 DtFedReader1516 (const DtFedReader1516 &)
 Copy constructor and Assignment operator - Unimplemented. More...
 
DtFedReader1516operator= (const DtFedReader1516 &)
 

Additional Inherited Members

- Static Public Member Functions inherited from DtXmlFedReader
static xmlNodegetNodeByName (xmlNode *currentNode, const xmlChar *nodeName)
 get the specified node More...
 
static const xmlCharchildContentByName (xmlNode *node, const xmlChar *name)
 Return the data for the specified child of the given node. More...
 
static DtFomType fomType (void *fedFilePtr)
 Inspect the file for indicators of what type of FOM file it is (1516, Evolved, 1516_2025, ...) More...
 
static DtFomType fomType (xmlNode *rootNode)
 Inspect the file for indicators of what type of FOM file it is (1516, Evolved, 1516_2025, ...) More...
 
- Static Public Member Functions inherited from DtFedReader
static const DtStringstandardMimFileName (DtFomType fomType)
 Return the standard MIM filename given the FOM type. More...
 
static bool isStandardMimFileName (DtString const &fileName, DtFomType fomType)
 Return true if file is the standard MIM file of the given type. More...
 
static FILE * openFedFile (const char *fileName, bool isBinary=false)
 Open file from name and return FILE*. More...
 
static bool readFileIntoBuffer (FILE *fileHandle, char **fileBuffer, unsigned int *fileSize)
 Read the file from the FILE* into the buffer. More...
 
static DtFomType checkFomType (const char *fedFileName, void *fedFilePtr)
 Get the FOM Type. More...
 
static DtFomType checkFomType (const char *fedFileName)
 Get the FOM Type. More...
 
- Public Attributes inherited from DtFedReader
char * myCurrFddBuffer
 Buffer containing the most recently read FDD file. More...
 
unsigned int myCurrFddBufferSize
 Size of the buffer for the most recently read FDD file. More...
 
- Static Public Attributes inherited from DtFedReader
static const DtString theHlaEvolvedStandardMimFileName
 
static const DtString theHla4StandardMimFileName
 
static const DtString theInvalidStandardMimFileName
 
- Protected Member Functions inherited from DtXmlFedReader
virtual DtFedReadStatus parseTransportationTree (xmlNode *currentNode)
 process the list of transportation classes More...
 
virtual void appendNodeProperties (xmlNode *currentNode, DtString &output) const
 Appends the list of properties attached to an XML node to the given string. More...
 
virtual void appendNodeContent (xmlNode *node, DtString &output) const
 Appends the name and content of the given node to the given string. More...
 
virtual bool isBlankText (xmlNode *node) const
 Return true if the node is blank text (space, tab, newline) More...
 
virtual const xmlCharpropertyByName (xmlNode *node, const xmlChar *name)
 Return the data for the specified property of the given node. More...
 
virtual bool getPropertyByName (xmlNode *node, const xmlChar *name, DtString &propertyContent)
 Fill in a string with the data for the specified property of the given node (empty string if property not found) Return true if property is found. More...
 
virtual bool getChildrenContent (xmlNode *node, DtString &content) const
 Get the children content of the given node into the given string. More...
 
virtual DtString childrenContent (xmlNode *node) const
 Return the children content of the given node. More...
 
virtual bool getChildContentByName (xmlNode *node, const xmlChar *name, DtString &childContent)
 Fill in a string with the data for the specified child of the given node (empty string if child not found) Return true if child is found. More...
 
virtual bool convertStringToULong (std::string numericString, unsigned long &value)
 Convert the given string to a long value. More...
 
template<typename stringType , typename charType >
void clipPrefix (stringType &valueSpec, charType c)
 Clip the characters from beginning of string up to the first occurrence of the given character. More...
 
- Protected Member Functions inherited from DtFedReader
void appendErrorLine (xmlNode *node, DtString &output) const
 
- Static Protected Attributes inherited from DtXmlFedReader
static const DtString theValueObjectRoot
 
static const DtString theValuePrivilegeToDelete
 
static const DtString theValueEnabled
 

Detailed Description

Instances of DtFedReader1516 are used to read a FED file, and fill in a DtFedTarget with the information read.

The FED file must be in the RTI 1516 XML file format

Constructor & Destructor Documentation

DtFedReader1516::DtFedReader1516 ( )
virtual DtFedReader1516::~DtFedReader1516 ( )
virtual
DtFedReader1516::DtFedReader1516 ( const DtFedReader1516 )
private

Copy constructor and Assignment operator - Unimplemented.

Member Function Documentation

virtual bool DtFedReader1516::dtdValidate ( xmlDoc pDoc,
const char *  dtdFile 
)
virtual

Validate the file against the given DTD.

virtual DtFedReadStatus DtFedReader1516::getNotes ( xmlNode currentNode,
DtString notesVal 
)
virtual
virtual DtFedReadStatus DtFedReader1516::getOrderType ( xmlNode currentNode,
DtOrderType orderType 
)
virtual

get the data for the Order attribute of the current node

virtual DtFedReadStatus DtFedReader1516::getOwnershipType ( xmlNode currentNode,
DtOwnershipType ownershipVal 
)
virtual
virtual DtFedReadStatus DtFedReader1516::getSemantics ( xmlNode currentNode,
DtString semanticsVal 
)
virtual
virtual DtFedReadStatus DtFedReader1516::getSharingType ( xmlNode currentNode,
DtSharingType sharingType 
)
virtual
virtual DtFedReadStatus DtFedReader1516::getTransportType ( xmlNode currentNode,
DtTransportType transportType 
)
virtual

get the data for the Transportation attribute of the current node

virtual DtFedReadStatus DtFedReader1516::getUpdateCondition ( xmlNode currentNode,
DtString updateConditionVal 
)
virtual
virtual DtFedReadStatus DtFedReader1516::getUpdateType ( xmlNode currentNode,
DtFomUpdateType updateTypeVal 
)
virtual
DtFedReader1516& DtFedReader1516::operator= ( const DtFedReader1516 )
private
virtual DtFedReadStatus DtFedReader1516::parseArrayDataTypesTree ( xmlNode currentNode)
virtual

process the list of array data types

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseAttribute ( xmlNode currentNode,
const DtString parentName 
)
virtual

process an attribute of an object class

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseAttributeDimensions ( xmlNode currentNode,
DtString const &  objectClass,
DtString const &  attribute 
)
virtual

process attribute dimension associations

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseBasicDataTypesTree ( xmlNode currentNode)
virtual

process the list of basic data representations

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseDataTypeTree ( xmlNode currentNode)
virtual

process the list of datatype classes

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseDimension ( xmlNode currentNode)
virtual

process a dimension

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseDimensionList ( xmlNode currentNode)
virtual

process the list of dimensions

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseEnumeratedDataTypesTree ( xmlNode currentNode)
virtual

process the list of enumerated data types

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseFixedRecordDataTypesTree ( xmlNode currentNode)
virtual

process the list of fixed record data types

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseInteractionDimensions ( xmlNode currentNode,
DtString const &  interactionClass 
)
virtual

process attribute dimension associations

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseInteractionTree ( xmlNode currentNode,
const DtString parentName 
)
virtual

process the list of interaction classes

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseNotesTree ( xmlNode currentNode)
virtual

process the list of notes classes

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseObjectTree ( xmlNode currentNode,
const DtString parentName 
)
virtual

process the list object of classes

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseParameter ( xmlNode currentNode,
const DtString parentName 
)
virtual

process a parameter of an interaction class

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseSimpleDataTypesTree ( xmlNode currentNode)
virtual

process the list of simple data types

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseSwitches ( xmlNode currentNode)
virtual

process switches

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseSynchronizationsTree ( xmlNode currentNode)
virtual
virtual DtFedReadStatus DtFedReader1516::parseTagsTree ( xmlNode currentNode)
virtual

process the list of user defined tags.

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseTimeTree ( xmlNode currentNode)
virtual
virtual DtFedReadStatus DtFedReader1516::parseTransportationsList ( xmlNode currentNode)
virtual

process the transportations directive (We need to override parseTransportationsList because VRL has a static list of transport types.)

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::parseVariantRecordDataTypesTree ( xmlNode currentNode)
virtual

process the list of variant record data types

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::processFed ( xmlNode fedObj)
virtual

process the FED directive

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::processInteractions ( xmlNode currentNode)
virtual

process the Interactions directive

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::processObjects ( xmlNode currentNode)
virtual

process the Objects directive

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516::processXmlDocPtr ( xmlDocPtr  xmlDocument)
virtual
virtual DtFedReadStatus DtFedReader1516::readFedFilePtr ( FILE *  filePointer,
DtFedTarget fedTarget,
DtFilename  fileName,
unsigned int  strictCheckingMask = DtFedReadStrictDisabled,
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.

Implements DtXmlFedReader.

Member Data Documentation

bool DtFedReader1516::myReplacedInteractionRoot
protected

Indicates when federation's FOM is 1.3 and root name has been replaced to match.

bool DtFedReader1516::myReplacedObjectRoot
protected

Indicates when federation's FOM is 1.3 and root name has been replaced to match.


The documentation for this class was generated from the following file:

Document ID: Generated on Thu Oct 16 00:12:25 EDT 2025 from SVN revision 280738
Copyright © 1992-2025 MAK Technologies. All Rights Reserved (www.mak.com)