Public Types
typedef std::map< DtString, DtString >	TokenToReaderWriterTypeMap

Public Member Functions
	DtVrfFileParser ()

virtual	~DtVrfFileParser ()

virtual bool	loadOrderOfBattleFile (const DtScenario &)

virtual bool	parseFile (const DtFilename &filename, bool includingDataBuffer=true)

virtual bool	parseBuffer (const DtString &buffer, bool includingDataBuffer=true)

virtual bool	parseOrderOfBattleFile (const DtlObjPtr &oobList, bool includingDataBuffer=true)

virtual bool	parseOrderOfBattleObject (const DtlObjPtr &args, bool includingDataBuffer=true)

virtual bool	parsePlanFile (const DtlObjPtr &plnList, bool includingDataBuffer=true)

virtual bool	parseGlobalPlanFile (const DtlObjPtr &plnList, bool includingDataBuffer=true)

virtual void	parsePlan (const DtlObjPtr &args, bool includingDataBuffer=true)

virtual const std::set< DtUUID > &	uuids () const

virtual const std::string &	getObjPtr (const DtUUID &) const

virtual bool	getData (const DtUUID &uuid, const std::set< DtString > &tokens, DtRwVariableBindings &) const

virtual bool	hasGlobalWeatherObject () const

virtual bool	hasGlobalDynamicTerrainObject () const

virtual void	clear ()

virtual void	setSimulationModelSets (const DtRwNLengthStringVector &)

const DtRwNLengthStringVector &	simulationModelSets () const

Static Public Member Functions
static void	addTokenToReaderWriterType (const DtString &, const DtString &)

Protected Member Functions
virtual bool	decomposeFromZipFile (const DtFilename &zip, const DtFilename &fileToParse, bool includingDataBuffer=true)

virtual void	addUUID (const DtUUID &, const DtlObjPtr &args, bool includingDataBuffer=true)

virtual bool	parseFile (DtlInputStream *f, bool includingDataBuffer=true)

virtual std::string	argsToStdString (const DtlObjPtr &args) const

virtual void	printToStream (std::ostringstream &dataStream, const DtlObjPtr &args) const

virtual void	printList (std::ostringstream &dataStream, const DtlObjPtr &args) const

virtual bool	getData (DtlObjPtr objPtr, std::set< DtString > &tokens, DtRwVariableBindings &) const

Protected Attributes
std::map< DtUUID, std::string >	myUUID2DataMap

std::map< DtUUID, DtlObjPtr >	myUUID2ObjPtrMap

std::set< DtUUID >	myUUIDsList

bool	myHasGlobalWeatherObject

bool	myHasGlobalDynamicTerrainObject

tbb::spin_mutex	myMutex

DtRwNLengthStringVector	mySimulationModelSets

DtlObjPtr *	myMtlFile = nullptr

Static Protected Attributes
static TokenToReaderWriterTypeMap	theTokenToReaderWriterTypeMap

Member Typedef Documentation

typedef std::map<DtString, DtString> DtVrfFileParser::TokenToReaderWriterTypeMap

Constructor & Destructor Documentation

DtVrfFileParser::DtVrfFileParser ( )

virtual DtVrfFileParser::~DtVrfFileParser ( )

virtual

Member Function Documentation

virtual bool DtVrfFileParser::loadOrderOfBattleFile ( const DtScenario & )

virtual

Loads the order of battle file from the scenario and readies it for the ability to getData from it.

virtual bool DtVrfFileParser::parseFile	(	const DtFilename &	filename,
		bool	includingDataBuffer = `true`
	)

virtual

Determines file type and delegates the rest of the parsing to the appropriate method.

virtual bool DtVrfFileParser::parseBuffer	(	const DtString &	buffer,
		bool	includingDataBuffer = `true`
	)

virtual

Parses the buffer as if it were a file.

virtual bool DtVrfFileParser::parseOrderOfBattleFile	(	const DtlObjPtr &	oobList,
		bool	includingDataBuffer = `true`
	)

virtual

Parse order of battle files.

virtual bool DtVrfFileParser::parseOrderOfBattleObject	(	const DtlObjPtr &	args,
		bool	includingDataBuffer = `true`
	)

virtual

virtual bool DtVrfFileParser::parsePlanFile	(	const DtlObjPtr &	plnList,
		bool	includingDataBuffer = `true`
	)

virtual

Checks to make sure that the plan file is at least version 2.0, and then calls parsePlan for each plan entry.

virtual bool DtVrfFileParser::parseGlobalPlanFile	(	const DtlObjPtr &	plnList,
		bool	includingDataBuffer = `true`
	)

virtual

virtual void DtVrfFileParser::parsePlan	(	const DtlObjPtr &	args,
		bool	includingDataBuffer = `true`
	)

virtual

Parses an individual plan.

virtual const std::set<DtUUID>& DtVrfFileParser::uuids ( ) const

virtual

virtual const std::string& DtVrfFileParser::getObjPtr ( const DtUUID & ) const

virtual

virtual bool DtVrfFileParser::getData	(	const DtUUID &	uuid,
		const std::set< DtString > &	tokens,
		DtRwVariableBindings &
	)		const

virtual

Given a list of tokens to look for put the resultant reader/writer values into the supplied variable bindings. The tokens are mapped to a particular reader/writer via the token factory that is part of this class. If there is no token found or no token factory entry, then, the variable will not be read in. The last file read in (order of battle, plan, etc) will be the one that is available for parsing.

static void DtVrfFileParser::addTokenToReaderWriterType	(	const DtString &	,
		const DtString &
	)

static

virtual bool DtVrfFileParser::hasGlobalWeatherObject ( ) const

inlinevirtual

Returns whether or not a global weather object was found in this file. Only valid for order of battle files.

virtual bool DtVrfFileParser::hasGlobalDynamicTerrainObject ( ) const

inlinevirtual

Returns whether or not a global dynamic terrain controller was found in this file. Only valid for order of battle files.

virtual void DtVrfFileParser::clear ( )

virtual

virtual void DtVrfFileParser::setSimulationModelSets ( const DtRwNLengthStringVector & )

virtual

If set, the simulation model set used when using the file parser. Will be set on new scenario for load balancing purposes.

const DtRwNLengthStringVector& DtVrfFileParser::simulationModelSets ( ) const

inline

virtual bool DtVrfFileParser::decomposeFromZipFile	(	const DtFilename &	zip,
		const DtFilename &	fileToParse,
		bool	includingDataBuffer = `true`
	)

protectedvirtual

If includingDataBuffer is false only the DtlObjPtr will be saved aas part of the parse, not the string representation of it too.

virtual void DtVrfFileParser::addUUID	(	const DtUUID &	,
		const DtlObjPtr &	args,
		bool	includingDataBuffer = `true`
	)

protectedvirtual

virtual bool DtVrfFileParser::parseFile	(	DtlInputStream *	f,
		bool	includingDataBuffer = `true`
	)

protectedvirtual

virtual std::string DtVrfFileParser::argsToStdString ( const DtlObjPtr & args ) const

protectedvirtual

virtual void DtVrfFileParser::printToStream	(	std::ostringstream &	dataStream,
		const DtlObjPtr &	args
	)		const

protectedvirtual

virtual void DtVrfFileParser::printList	(	std::ostringstream &	dataStream,
		const DtlObjPtr &	args
	)		const

protectedvirtual

virtual bool DtVrfFileParser::getData	(	DtlObjPtr	objPtr,
		std::set< DtString > &	tokens,
		DtRwVariableBindings &
	)		const

protectedvirtual

Member Data Documentation

std::map<DtUUID, std::string> DtVrfFileParser::myUUID2DataMap

protected

std::map<DtUUID, DtlObjPtr> DtVrfFileParser::myUUID2ObjPtrMap

protected

std::set<DtUUID> DtVrfFileParser::myUUIDsList

protected

bool DtVrfFileParser::myHasGlobalWeatherObject

protected

bool DtVrfFileParser::myHasGlobalDynamicTerrainObject

protected

tbb::spin_mutex DtVrfFileParser::myMutex

protected

TokenToReaderWriterTypeMap DtVrfFileParser::theTokenToReaderWriterTypeMap

staticprotected

DtRwNLengthStringVector DtVrfFileParser::mySimulationModelSets

protected

DtlObjPtr* DtVrfFileParser::myMtlFile = nullptr

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/vrfFileParser.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation