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

virtual	~DtFedReader1516e ()
	Destructor. 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 void	setSchemaValidationEnabled (bool enabled)
	Sets whether or not schema validation should be performed. 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 DtString &	lastError () const
	Get the last error. More...

char *	takeCurrFddData ()

Protected Member Functions
virtual DtFedReadStatus	processXmlDocPtr (xmlDocPtr xmlDocument)
	Process the XML document. More...

virtual DtFedReadStatus	parseTimeTree (xmlNode *currentNode)
	process the time directive More...

virtual DtFedReadStatus	parseSynchronizationsTree (xmlNode *currentNode)
	process the synchronization points directive More...

DtFedReadStatus	getSharingType (xmlNode *currentNode, DtSharingType &sharingType)
	get the data for the sharing type attribute of the current node More...

DtFedReadStatus	getSemantics (xmlNode *currentNode, DtString &semanticsVal)
	get the data for the semantics attribute of the current node More...

DtFedReadStatus	getNotes (xmlNode *currentNode, DtString &notesVal)
	get the data for the notes attribute of the current node More...

DtFedReadStatus	getOwnershipType (xmlNode *currentNode, DtOwnershipType &ownershipVal)
	get the data for the ownership type attribute of the current node More...

DtFedReadStatus	getUpdateCondition (xmlNode *currentNode, DtString &updateConditionVal)
	get the data for the update condition attribute of the current node More...

DtFedReadStatus	getUpdateType (xmlNode *currentNode, DtFomUpdateType &updateTypeVal)
	get the data for the update type attribute of the current node More...

virtual bool	schemaValidate (xmlDoc pDoc, const char schemaFile)
	Validate the file against the given DTD. More...

virtual DtFedReadStatus	processFed (xmlNode *fedObj)
	process the FED directive More...

virtual DtFedReadStatus	parseTransportationsList (xmlNode *currentNode)
	process the transportations directive More...

virtual DtFedReadStatus	processModelIdentification (xmlNode *currentNode)
	process the Model Identification directive 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	parseObjectDimensions (xmlNode *currentNode, DtString const &objectClass)
	process object class dimension associations 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	parseUpdateRates (xmlNode *currentNode)
	process update rates 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 nodes More...

virtual DtFedReadStatus	parseDataType (xmlNode *currentNode)
	process a datatype node More...

virtual DtFedReadStatus	parseNotesTree (xmlNode *currentNode)
	process the list of notes nodes 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 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 const xmlChar *	propertyByName (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 DtFedReadStatus	getTransportType (xmlNode *currentNode, DtTransportType &transportType, DtNamePair nameType, bool isAttribute)
	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...

virtual DtFedReadStatus	readFedFilePtr (FILE filePointer, DtFedTarget fedTarget, DtFilename fileName, DtFomType fomType, unsigned int strictCheckingMask=DtFedReadStrictDisabled, bool useDTD=false, bool dontParseSwitches=false)
	Read the FED file fedFileName, setting values to fedTarget. More...

Protected Member Functions inherited from DtXmlFedReader
virtual DtFedReadStatus	parseTransportationTree (xmlNode *currentNode)
	process the list of transportation classes More...

virtual bool	isBlankText (xmlNode *node) const
	Return true if the node is blank text (space, tab, newline) 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

Protected Attributes
bool	mySchemaValidationEnabled


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


char *	myHLAstandardMIM_xml
	The HLA Standard MIM in a byte array and its length. More...

unsigned int	myHLAstandardMIM_xml_len
	The HLA Standard MIM in a byte array and its length. More...


const xmlChar *	myLogicalTimeAttribute
	The name of the logical time and logical time interval attributes. More...

const xmlChar *	myLogicalTimeIntervalAttribute
	The name of the logical time and logical time interval attributes. More...

Protected Attributes inherited from DtXmlFedReader
DtFedTarget *	myFedTarget

DtFilename	myFileBeingRead

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

DtFomType	myLastFomType
	The type of FOM format that was last read. More...

DtString	myLastError
	Description of last encountered error. More...

Private Member Functions

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

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

Additional Inherited Members
Static Public Member Functions inherited from DtXmlFedReader
static xmlNode *	getNodeByName (xmlNode currentNode, const xmlChar nodeName)
	get the specified node More...

static const xmlChar *	childContentByName (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 DtString &	standardMimFileName (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

Static Protected Attributes inherited from DtXmlFedReader
static const DtString	theValueObjectRoot

static const DtString	theValuePrivilegeToDelete

static const DtString	theValueEnabled

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.

Reimplemented from DtXmlFedReader.

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

protectedvirtual

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

Reimplemented from DtXmlFedReader.

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

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

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.

Reimplemented from DtXmlFedReader.

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,
		DtNamePair	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

DtFedReader1516e& DtFedReader1516e::operator= ( const DtFedReader1516e & )

private

Copy constructor and Assignment operator - Unimplemented.

virtual DtFedReadStatus DtFedReader1516e::parseArrayDataTypesTree ( xmlNode * currentNode )

protectedvirtual

process the list of array data types

Implements DtXmlFedReader.

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

protectedvirtual

process an attribute of an object class

Implements DtXmlFedReader.

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

protectedvirtual

process attribute dimension associations

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseBasicDataTypesTree ( xmlNode * currentNode )

protectedvirtual

process the list of basic data representations

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseDataType ( xmlNode * currentNode )

protectedvirtual

process a datatype node

Reimplemented in DtFedReader1516_4.

virtual DtFedReadStatus DtFedReader1516e::parseDataTypeTree ( xmlNode * currentNode )

protectedvirtual

process the list of datatype nodes

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseDimension ( xmlNode * currentNode )

protectedvirtual

process a dimension

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseDimensionList ( xmlNode * currentNode )

protectedvirtual

process the list of dimensions

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseEnumeratedDataTypesTree ( xmlNode * currentNode )

protectedvirtual

process the list of enumerated data types

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseFixedRecordDataTypesTree ( xmlNode * currentNode )

protectedvirtual

process the list of fixed record data types

Implements DtXmlFedReader.

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

protectedvirtual

process attribute dimension associations

Implements DtXmlFedReader.

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

protectedvirtual

process the list of interaction classes

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseNotesTree ( xmlNode * currentNode )

protectedvirtual

process the list of notes nodes

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseObjectDimensions	(	xmlNode *	currentNode,
		DtString const &	objectClass
	)

protectedvirtual

process object class dimension associations

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

protectedvirtual

process the list object of classes

Implements DtXmlFedReader.

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

protectedvirtual

process a parameter of an interaction class

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseSimpleDataTypesTree ( xmlNode * currentNode )

protectedvirtual

process the list of simple data types

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseSwitches ( xmlNode * currentNode )

protectedvirtual

process switches

Implements DtXmlFedReader.

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.

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::parseTimeTree ( xmlNode * currentNode )

protectedvirtual

process the time directive

virtual DtFedReadStatus DtFedReader1516e::parseTransportationsList ( xmlNode * currentNode )

protectedvirtual

process the transportations directive

Implements DtXmlFedReader.

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

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::processFed ( xmlNode * fedObj )

protectedvirtual

process the FED directive

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::processInteractions ( xmlNode * currentNode )

protectedvirtual

process the Interactions directive

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::processModelIdentification ( xmlNode * currentNode )

protectedvirtual

process the Model Identification directive

virtual DtFedReadStatus DtFedReader1516e::processObjects ( xmlNode * currentNode )

protectedvirtual

process the Objects directive

Implements DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::processXmlDocPtr ( xmlDocPtr xmlDocument )

protectedvirtual

Process the XML document.

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

protectedvirtual

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

Reimplemented from DtXmlFedReader.

virtual DtFedReadStatus DtFedReader1516e::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.

Reimplemented in DtFedReader1516_4.

virtual DtFedReadStatus DtFedReader1516e::readFedFilePtr	(	FILE *	filePointer,
		DtFedTarget *	fedTarget,
		DtFilename	fileName,
		DtFomType	fomType,
		unsigned int	strictCheckingMask = `DtFedReadStrictDisabled`,
		bool	useDTD = `false`,
		bool	dontParseSwitches = `false`
	)

protectedvirtual

Read the FED file fedFileName, setting values to fedTarget.

Note if fedTarget is NULL the fedfile will be read and verified only.

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

char* DtFedReader1516e::myHLAstandardMIM_xml

protected

The HLA Standard MIM in a byte array and its length.

unsigned int DtFedReader1516e::myHLAstandardMIM_xml_len

protected

The HLA Standard MIM in a byte array and its length.

const xmlChar* DtFedReader1516e::myLogicalTimeAttribute

protected

The name of the logical time and logical time interval attributes.

const xmlChar* DtFedReader1516e::myLogicalTimeIntervalAttribute

protected

The name of the logical time and logical time interval attributes.

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:

fedReader1516e.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation