DtFedReader1516 Class Reference

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.
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.
virtual DtFedReadStatus	processXmlDocPtr (xmlDocPtr xmlDocument)
DtFedReadStatus	parseTimeTree (xmlNode *currentNode)
DtFedReadStatus	parseSynchronizationsTree (xmlNode *currentNode)
DtFedReadStatus	getSharingType (xmlNode *currentNode, DtSharingType &sharingType)
DtFedReadStatus	getSemantics (xmlNode *currentNode, DtString &semanticsVal)
DtFedReadStatus	getNotes (xmlNode *currentNode, DtString &notesVal)
DtFedReadStatus	getOwnershipType (xmlNode *currentNode, DtOwnershipType &ownershipVal)
DtFedReadStatus	getUpdateCondition (xmlNode *currentNode, DtString &updateConditionVal)
DtFedReadStatus	getUpdateType (xmlNode *currentNode, DtFomUpdateType &updateTypeVal)
virtual xmlNode *	getNodeByName (xmlNode *currentNode, const xmlChar *nodeName)
	get the specified node
virtual DtFedReadStatus	processFed (xmlNode *fedObj)
	process the FED directive
virtual DtFedReadStatus	parseTransportationsList (xmlNode *currentNode)
	process the transportations directive (We need to override parseTransportationsList because VRL has a static list of transport types.)
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	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 DtFedReadStatus	getTransportType (xmlNode *currentNode, DtTransportType &transportType)
	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)
Public Member Functions inherited from DtFedReader
	DtFedReader ()
	Constructor.
virtual	~DtFedReader ()
	Destructor.
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.
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 unsigned int	setStrictChecking (unsigned int checkMask)
	Set status of strict checking.
virtual bool	strictChecking (unsigned int checkMask) const
	Returns bool: strictChecking enabled for types of checks provided.
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 ()

Protected Attributes
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
unsigned int	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
	DtFedReader1516 (const DtFedReader1516 &)
	Copy constructor and Assignment operator - Unimplemented.
DtFedReader1516 &	operator= (const DtFedReader1516 &)

Additional Inherited Members
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.
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.
Protected Member Functions inherited from DtFedReader
void	appendErrorLine (xmlNode *node, DtString &output) const

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 void DtFedReader1516::appendNodeContent ( xmlNode *  node, DtString &  output  ) const

virtual

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

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

virtual

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

template<typename operandType >

void DtFedReader1516::clipPrefix	(	std::string &	valueSpec,
		operandType	c
	)

bool DtFedReader1516::convertStringToULong	(	std::string	numericString,
		unsigned long &	value
	)

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

virtual

Validate the file against the given DTD.

virtual xmlNode* DtFedReader1516::getNodeByName ( xmlNode *  currentNode, const xmlChar *  nodeName  )

virtual

get the specified node

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

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

virtual

get the data for the Order attribute of the current node

DtFedReadStatus DtFedReader1516::getOwnershipType	(	xmlNode *	currentNode,
		DtOwnershipType &	ownershipVal
	)

virtual bool DtFedReader1516::getPropertyByName ( xmlNode *  node, const xmlChar *  name, DtString &  propertyContent  )

virtual

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 DtFedReader1516::getSemantics	(	xmlNode *	currentNode,
		DtString &	semanticsVal
	)

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

virtual DtFedReadStatus DtFedReader1516::getTransportType ( xmlNode *  currentNode, DtTransportType &  transportType  )

virtual

get the data for the Transportation attribute of the current node

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

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

virtual bool DtFedReader1516::isBlankText ( xmlNode *  node ) const

virtual

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

DtFedReader1516& DtFedReader1516::operator= ( const DtFedReader1516 &  )

private

virtual DtFedReadStatus DtFedReader1516::parseArrayDataTypesTree ( xmlNode *  currentNode )

virtual

process the list of array data types

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

virtual

process an attribute of an object class

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

virtual

process attribute dimension associations

virtual DtFedReadStatus DtFedReader1516::parseBasicDataTypesTree ( xmlNode *  currentNode )

virtual

process the list of basic data representations

virtual DtFedReadStatus DtFedReader1516::parseDataTypeTree ( xmlNode *  currentNode )

virtual

process the list of datatype classes

virtual DtFedReadStatus DtFedReader1516::parseDimension ( xmlNode *  currentNode )

virtual

process a dimension

virtual DtFedReadStatus DtFedReader1516::parseDimensionList ( xmlNode *  currentNode )

virtual

process the list of dimensions

virtual DtFedReadStatus DtFedReader1516::parseEnumeratedDataTypesTree ( xmlNode *  currentNode )

virtual

process the list of enumerated data types

virtual DtFedReadStatus DtFedReader1516::parseFixedRecordDataTypesTree ( xmlNode *  currentNode )

virtual

process the list of fixed record data types

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

virtual

process attribute dimension associations

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

virtual

process the list of interaction classes

virtual DtFedReadStatus DtFedReader1516::parseNotesTree ( xmlNode *  currentNode )

virtual

process the list of notes classes

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

virtual

process the list object of classes

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

virtual

process a parameter of an interaction class

virtual DtFedReadStatus DtFedReader1516::parseSimpleDataTypesTree ( xmlNode *  currentNode )

virtual

process the list of simple data types

virtual DtFedReadStatus DtFedReader1516::parseSwitches ( xmlNode *  currentNode )

virtual

process switches

DtFedReadStatus DtFedReader1516::parseSynchronizationsTree

(

xmlNode *

currentNode

)

virtual DtFedReadStatus DtFedReader1516::parseTagsTree ( xmlNode *  currentNode )

virtual

process the list of user defined tags.

DtFedReadStatus DtFedReader1516::parseTimeTree

(

xmlNode *

currentNode

)

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.)

virtual DtFedReadStatus DtFedReader1516::parseVariantRecordDataTypesTree ( xmlNode *  currentNode )

virtual

process the list of variant record data types

virtual DtFedReadStatus DtFedReader1516::processFed ( xmlNode *  fedObj )

virtual

process the FED directive

virtual DtFedReadStatus DtFedReader1516::processInteractions ( xmlNode *  currentNode )

virtual

process the Interactions directive

virtual DtFedReadStatus DtFedReader1516::processObjects ( xmlNode *  currentNode )

virtual

process the Objects directive

virtual DtFedReadStatus DtFedReader1516::processXmlDocPtr ( xmlDocPtr  xmlDocument )

virtual

virtual const xmlChar* DtFedReader1516::propertyByName ( xmlNode *  node, const xmlChar *  name  )

virtual

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

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 DtFedReader.

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:

• fedReader1516.h