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 | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions
DtFedReader1516e Class Reference
The VR-Link MAK Technologies LISP Library (mtl)

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

+ Inheritance diagram for DtFedReader1516e:
+ Collaboration diagram for DtFedReader1516e:

Public Member Functions

 DtFedReader1516e ()
 Constructor.
virtual ~DtFedReader1516e ()
 Destructor.
virtual DtFedReadStatus readFedFilePtr (FILE *filePointer, DtFedTarget *fedTarget, DtFilename fileName, bool strictCheckingEnabled=false, bool useDTD=false, bool dontParseSwitches=false)
 Read the FED file fedFileName, setting values to fedTarget.
virtual void setSchemaValidationEnabled (bool enabled)
 Sets whether or not schema validation should be performed.
bool getChildrenContent (xmlNode *node, DtString &content) const
DtString getChildrenContent (xmlNode *node) const
- Public Member Functions inherited from DtFedReader
 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 FILE * openFedFileWithErrCheck (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.
char * takeCurrFddData ()

Static Public Member Functions

static bool isEvolvedFormat (void *fedFilePtr)
- Static Public Member Functions inherited from DtFedReader
static DtFomType checkFomType (const char *fedFileName, void *fedFilePtr)
 Get the FOM Type.
static FILE * openFedFile (const char *fileName, bool isBinary=false)
 Open file from name and return FILE*.
static bool readFileIntoBuffer (FILE *fileHandle, char **fileBuffer, unsigned int *fileSize)
 Read the file from the FILE* into the buffer.

Protected Member Functions

virtual DtFedReadStatus processXmlDocPtr (xmlDocPtr xmlDocument)
virtual DtFedReadStatus parseTimeTree (xmlNode *currentNode)
 process the time directive
virtual DtFedReadStatus parseSynchronizationsTree (xmlNode *currentNode)
 process the synchronization points directive
DtFedReadStatus getSharingType (xmlNode *currentNode, DtSharingType &sharingType)
 get the data for the sharing type attribute of the current node
DtFedReadStatus getSemantics (xmlNode *currentNode, DtString &semanticsVal)
 get the data for the semantics attribute of the current node
DtFedReadStatus getNotes (xmlNode *currentNode, DtString &notesVal)
 get the data for the notes attribute of the current node
DtFedReadStatus getOwnershipType (xmlNode *currentNode, DtOwnershipType &ownershipVal)
DtFedReadStatus getUpdateCondition (xmlNode *currentNode, DtString &updateConditionVal)
 get the data for the update condition attribute of the current node
DtFedReadStatus getUpdateType (xmlNode *currentNode, DtFomUpdateType &updateTypeVal)
 get the data for the update type attribute of the current node
virtual bool schemaValidate (xmlDoc *pDoc, const char *schemaFile)
 Validate the file against the given DTD.
virtual DtFedReadStatus processFed (xmlNode *fedObj)
 process the FED directive
virtual DtFedReadStatus parseTransportationsList (xmlNode *currentNode)
 process the transportations directive
virtual DtFedReadStatus processModelIdentification (xmlNode *currentNode)
 process the Model Identification directive
virtual DtFedReadStatus processObjects (xmlNode *currentNode)
 process the Objects directive
virtual DtFedReadStatus processInteractions (xmlNode *currentNode)
 process the Interactions directive
virtual DtFedReadStatus parseObjectTree (xmlNode *currentNode, const DtString &parentName)
 process the list object of classes
virtual DtFedReadStatus parseAttribute (xmlNode *currentNode, const DtString &parentName)
 process an attribute of an object class
virtual DtFedReadStatus parseAttributeDimensions (xmlNode *currentNode, DtString const &objectClass, DtString const &attribute)
 process attribute dimension associations
virtual DtFedReadStatus parseInteractionTree (xmlNode *currentNode, const DtString &parentName)
 process the list of interaction classes
virtual DtFedReadStatus parseInteractionDimensions (xmlNode *currentNode, DtString const &interactionClass)
 process attribute dimension associations
virtual DtFedReadStatus parseDimensionList (xmlNode *currentNode)
 process the list of dimensions
virtual DtFedReadStatus parseDimension (xmlNode *currentNode)
 process a dimension
virtual DtFedReadStatus parseSwitches (xmlNode *currentNode)
 process switches
virtual DtFedReadStatus parseUpdateRates (xmlNode *currentNode)
 process update rates
virtual DtFedReadStatus parseParameter (xmlNode *currentNode, const DtString &parentName)
 process a parameter of an interaction class
virtual DtFedReadStatus parseDataTypeTree (xmlNode *currentNode)
 process the list of datatype classes
virtual DtFedReadStatus parseNotesTree (xmlNode *currentNode)
 process the list of notes classes
virtual DtFedReadStatus parseTagsTree (xmlNode *currentNode)
 process the list of user defined tags.
virtual DtFedReadStatus parseBasicDataTypesTree (xmlNode *currentNode)
 process the list of basic data representations
virtual DtFedReadStatus parseSimpleDataTypesTree (xmlNode *currentNode)
 process the list of simple data types
virtual DtFedReadStatus parseArrayDataTypesTree (xmlNode *currentNode)
 process the list of array data types
virtual DtFedReadStatus parseEnumeratedDataTypesTree (xmlNode *currentNode)
 process the list of enumerated data types
virtual DtFedReadStatus parseFixedRecordDataTypesTree (xmlNode *currentNode)
 process the list of fixed record data types
virtual DtFedReadStatus parseVariantRecordDataTypesTree (xmlNode *currentNode)
 process the list of variant record data types
virtual void appendNodeProperties (xmlNode *currentNode, DtString &output) const
 Appends the list of properties attached to an XML node to the given string.
virtual void appendNodeContent (xmlNode *node, DtString &output) const
 Appends the name and content of the given node to the given string.
virtual bool isBlankText (xmlNode *node) const
 Return true if the node is blank text (space, tab, newline)
virtual const xmlChar * propertyByName (xmlNode *node, const xmlChar *name)
 Return the data for the specified property of the given node.
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.
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.
virtual DtFedReadStatus getTransportType (xmlNode *currentNode, DtTransportType &transportType, DtNameTypePair nameType, bool isAttribute)
 get the data for the Transportation attribute of the current node
virtual DtFedReadStatus getOrderType (xmlNode *currentNode, DtOrderType &orderType)
 get the data for the Order attribute of the current node
bool convertStringToULong (std::string numericString, unsigned long &value)
template<typename operandType >
void clipPrefix (std::string &valueSpec, operandType c)
- Protected Member Functions inherited from DtFedReader
void appendErrorLine (xmlNode *node, DtString &output) const

Static Protected Member Functions

static xmlNode * getNodeByName (xmlNode *currentNode, const xmlChar *nodeName)
 get the specified node
static const xmlChar * childContentByName (xmlNode *node, const xmlChar *name)
 Return the data for the specified child of the given node.

Protected Attributes

bool mySchemaValidationEnabled
bool myReplacedObjectRoot
 Indicates when federation's FOM is 1.3 and root name has been replaced to match.
bool myReplacedInteractionRoot
 Indicates when federation's FOM is 1.3 and root name has been replaced to match.
- Protected Attributes inherited from DtFedReader
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

 DtFedReader1516e (const DtFedReader1516e &)
 Copy constructor and Assignment operator - Unimplemented.
DtFedReader1516e & operator= (const DtFedReader1516e &)

Additional Inherited Members

- Public Attributes inherited from DtFedReader
char * myCurrFddBuffer
 Buffer containing the most recently read FDD file.
unsigned int myCurrFddBufferSize
 Size of the buffer for the most recently read FDD file.

Detailed Description

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

The FED file must be in the HLA Evolved XML file format

Constructor & Destructor Documentation

DtFedReader1516e::DtFedReader1516e ( )

Constructor.

virtual DtFedReader1516e::~DtFedReader1516e ( )
virtual

Destructor.

DtFedReader1516e::DtFedReader1516e ( const DtFedReader1516e &  )
private

Copy constructor and Assignment operator - Unimplemented.

Member Function Documentation

virtual void DtFedReader1516e::appendNodeContent ( xmlNode *  node,
DtString &  output 
) const
protectedvirtual

Appends the name and content of the given node to the given string.

virtual void DtFedReader1516e::appendNodeProperties ( xmlNode *  currentNode,
DtString &  output 
) const
protectedvirtual

Appends the list of properties attached to an XML node to the given string.

static const xmlChar* DtFedReader1516e::childContentByName ( xmlNode *  node,
const xmlChar *  name 
)
staticprotected

Return the data for the specified child of the given node.

template<typename operandType >
void DtFedReader1516e::clipPrefix ( std::string &  valueSpec,
operandType  c 
)
protected
bool DtFedReader1516e::convertStringToULong ( std::string  numericString,
unsigned long &  value 
)
protected
virtual bool DtFedReader1516e::getChildContentByName ( xmlNode *  node,
const xmlChar *  name,
DtString &  childContent 
)
protectedvirtual

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.

bool DtFedReader1516e::getChildrenContent ( xmlNode *  node,
DtString &  content 
) const
DtString DtFedReader1516e::getChildrenContent ( xmlNode *  node) const
static xmlNode* DtFedReader1516e::getNodeByName ( xmlNode *  currentNode,
const xmlChar *  nodeName 
)
staticprotected

get the specified node

DtFedReadStatus DtFedReader1516e::getNotes ( xmlNode *  currentNode,
DtString &  notesVal 
)
protected

get the data for the notes attribute of the current node

virtual DtFedReadStatus DtFedReader1516e::getOrderType ( xmlNode *  currentNode,
DtOrderType &  orderType 
)
protectedvirtual

get the data for the Order attribute of the current node

DtFedReadStatus DtFedReader1516e::getOwnershipType ( xmlNode *  currentNode,
DtOwnershipType &  ownershipVal 
)
protected
virtual bool DtFedReader1516e::getPropertyByName ( xmlNode *  node,
const xmlChar *  name,
DtString &  propertyContent 
)
protectedvirtual

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.

DtFedReadStatus DtFedReader1516e::getSemantics ( xmlNode *  currentNode,
DtString &  semanticsVal 
)
protected

get the data for the semantics attribute of the current node

DtFedReadStatus DtFedReader1516e::getSharingType ( xmlNode *  currentNode,
DtSharingType &  sharingType 
)
protected

get the data for the sharing type attribute of the current node

virtual DtFedReadStatus DtFedReader1516e::getTransportType ( xmlNode *  currentNode,
DtTransportType &  transportType,
DtNameTypePair  nameType,
bool  isAttribute 
)
protectedvirtual

get the data for the Transportation attribute of the current node

DtFedReadStatus DtFedReader1516e::getUpdateCondition ( xmlNode *  currentNode,
DtString &  updateConditionVal 
)
protected

get the data for the update condition attribute of the current node

DtFedReadStatus DtFedReader1516e::getUpdateType ( xmlNode *  currentNode,
DtFomUpdateType &  updateTypeVal 
)
protected

get the data for the update type attribute of the current node

virtual bool DtFedReader1516e::isBlankText ( xmlNode *  node) const
protectedvirtual

Return true if the node is blank text (space, tab, newline)

static bool DtFedReader1516e::isEvolvedFormat ( void *  fedFilePtr)
static
DtFedReader1516e& DtFedReader1516e::operator= ( const DtFedReader1516e &  )
private
virtual DtFedReadStatus DtFedReader1516e::parseArrayDataTypesTree ( xmlNode *  currentNode)
protectedvirtual

process the list of array data types

virtual DtFedReadStatus DtFedReader1516e::parseAttribute ( xmlNode *  currentNode,
const DtString &  parentName 
)
protectedvirtual

process an attribute of an object class

virtual DtFedReadStatus DtFedReader1516e::parseAttributeDimensions ( xmlNode *  currentNode,
DtString const &  objectClass,
DtString const &  attribute 
)
protectedvirtual

process attribute dimension associations

virtual DtFedReadStatus DtFedReader1516e::parseBasicDataTypesTree ( xmlNode *  currentNode)
protectedvirtual

process the list of basic data representations

virtual DtFedReadStatus DtFedReader1516e::parseDataTypeTree ( xmlNode *  currentNode)
protectedvirtual

process the list of datatype classes

virtual DtFedReadStatus DtFedReader1516e::parseDimension ( xmlNode *  currentNode)
protectedvirtual

process a dimension

virtual DtFedReadStatus DtFedReader1516e::parseDimensionList ( xmlNode *  currentNode)
protectedvirtual

process the list of dimensions

virtual DtFedReadStatus DtFedReader1516e::parseEnumeratedDataTypesTree ( xmlNode *  currentNode)
protectedvirtual

process the list of enumerated data types

virtual DtFedReadStatus DtFedReader1516e::parseFixedRecordDataTypesTree ( xmlNode *  currentNode)
protectedvirtual

process the list of fixed record data types

virtual DtFedReadStatus DtFedReader1516e::parseInteractionDimensions ( xmlNode *  currentNode,
DtString const &  interactionClass 
)
protectedvirtual

process attribute dimension associations

virtual DtFedReadStatus DtFedReader1516e::parseInteractionTree ( xmlNode *  currentNode,
const DtString &  parentName 
)
protectedvirtual

process the list of interaction classes

virtual DtFedReadStatus DtFedReader1516e::parseNotesTree ( xmlNode *  currentNode)
protectedvirtual

process the list of notes classes

virtual DtFedReadStatus DtFedReader1516e::parseObjectTree ( xmlNode *  currentNode,
const DtString &  parentName 
)
protectedvirtual

process the list object of classes

virtual DtFedReadStatus DtFedReader1516e::parseParameter ( xmlNode *  currentNode,
const DtString &  parentName 
)
protectedvirtual

process a parameter of an interaction class

virtual DtFedReadStatus DtFedReader1516e::parseSimpleDataTypesTree ( xmlNode *  currentNode)
protectedvirtual

process the list of simple data types

virtual DtFedReadStatus DtFedReader1516e::parseSwitches ( xmlNode *  currentNode)
protectedvirtual

process switches

virtual DtFedReadStatus DtFedReader1516e::parseSynchronizationsTree ( xmlNode *  currentNode)
protectedvirtual

process the synchronization points directive

virtual DtFedReadStatus DtFedReader1516e::parseTagsTree ( xmlNode *  currentNode)
protectedvirtual

process the list of user defined tags.

virtual DtFedReadStatus DtFedReader1516e::parseTimeTree ( xmlNode *  currentNode)
protectedvirtual

process the time directive

virtual DtFedReadStatus DtFedReader1516e::parseTransportationsList ( xmlNode *  currentNode)
protectedvirtual

process the transportations directive

virtual DtFedReadStatus DtFedReader1516e::parseUpdateRates ( xmlNode *  currentNode)
protectedvirtual

process update rates

virtual DtFedReadStatus DtFedReader1516e::parseVariantRecordDataTypesTree ( xmlNode *  currentNode)
protectedvirtual

process the list of variant record data types

virtual DtFedReadStatus DtFedReader1516e::processFed ( xmlNode *  fedObj)
protectedvirtual

process the FED directive

virtual DtFedReadStatus DtFedReader1516e::processInteractions ( xmlNode *  currentNode)
protectedvirtual

process the Interactions directive

virtual DtFedReadStatus DtFedReader1516e::processModelIdentification ( xmlNode *  currentNode)
protectedvirtual

process the Model Identification directive

virtual DtFedReadStatus DtFedReader1516e::processObjects ( xmlNode *  currentNode)
protectedvirtual

process the Objects directive

virtual DtFedReadStatus DtFedReader1516e::processXmlDocPtr ( xmlDocPtr  xmlDocument)
protectedvirtual
virtual const xmlChar* DtFedReader1516e::propertyByName ( xmlNode *  node,
const xmlChar *  name 
)
protectedvirtual

Return the data for the specified property of the given node.

virtual DtFedReadStatus DtFedReader1516e::readFedFilePtr ( FILE *  filePointer,
DtFedTarget *  fedTarget,
DtFilename  fileName,
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.

Implements DtFedReader.

virtual bool DtFedReader1516e::schemaValidate ( xmlDoc *  pDoc,
const char *  schemaFile 
)
protectedvirtual

Validate the file against the given DTD.

virtual void DtFedReader1516e::setSchemaValidationEnabled ( bool  enabled)
virtual

Sets whether or not schema validation should be performed.

Member Data Documentation

bool DtFedReader1516e::myReplacedInteractionRoot
protected

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

bool DtFedReader1516e::myReplacedObjectRoot
protected

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

bool DtFedReader1516e::mySchemaValidationEnabled
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Fri May 15 06:36:13 EDT 2015 from SVN revision 153263
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)