DtIfLoadScenario Class Reference

DtIfLoadScenario is a composite message containing all the elements needed to begin a simulation. More...

Inheritance diagram for DtIfLoadScenario:

List of all members.

Public Member Functions
	DtIfLoadScenario ()
	default constructor
virtual	~DtIfLoadScenario ()
	destructor
	DtIfLoadScenario (const DtIfLoadScenario &orig)
	copy constructor
DtIfLoadScenario &	operator= (const DtIfLoadScenario &orig)
	assignment operator
virtual DtSimInterfaceContent *	clone () const
virtual int	type () const
virtual const DtFilename &	componentAttachmentTableFileName () const
virtual void	setComponentAttachmentTableFileName (const DtString &fileName)
virtual const DtFilename &	terrainFileName () const
virtual void	setTerrainFileName (const DtString &fileName)
virtual const DtFilename &	guiTerrainFileName () const
virtual void	setGuiTerrainFileName (const DtString &fileName)
virtual const bool &	autoReorganize () const
virtual void	setAutoReorganize (bool yesNo)
virtual double	timeMultiplier () const
virtual void	setTimeMultiplier (double timeMultiplier)
virtual const DtFilename &	objectParametersFileName () const
virtual void	setObjectParametersFileName (const DtString &fileName)
virtual const DtFilename &	physicalWorldFileName () const
virtual void	setPhysicalWorldFileName (const DtString &fileName)
virtual const DtFilename &	orderOfBattleFileName () const
virtual void	setOrderOfBattleFileName (const DtString &fileName)
virtual const DtFilename &	planFileName () const
virtual void	setPlanFileName (const DtString &fileName)
virtual unsigned int	randomNumberSeed () const
virtual void	setRandomNumberSeed (unsigned int numberSeed)
virtual int	frameMode () const
virtual void	setFrameMode (int frameMode)
virtual double	frameTime () const
virtual void	setFrameTime (double frameTime)
virtual void	setSimTime (DtTime time)
	Set/get simulation time.
virtual DtTime	simTime () const
virtual void	setExerciseStartTime (DtTime time)
	Set/get exercise start time.
virtual DtTime	exerciseStartTime () const
virtual unsigned long	requestId () const
virtual void	setRequestId (unsigned long requestId)
virtual std::list< DtString > &	additionalOpdFileNames ()
virtual const std::list < DtString > &	additionalOpdFileNames () const
virtual std::list< DtString > &	simulationModelSetFileNames ()
virtual const std::list < DtString > &	simulationModelSetFileNames () const
virtual const DtFilename &	globalPlanFileName () const
virtual void	setGlobalPlanFileName (const DtString &fileName)
virtual const DtFilename &	forceHostilityFileName () const
virtual void	setForceHostilityFileName (const DtString &fileName)
virtual const DtFilename &	scenarioExtrasFileName () const
virtual void	setScenarioExtrasFileName (const DtString &fileName)
virtual DtString	scenarioName () const
virtual void	setScenarioName (const DtString &name)
virtual const DtRwKeyValueList &	scenarioData () const
virtual DtRwKeyValueList &	scenarioData ()
virtual void	setScenarioData (const DtRwKeyValueList &data)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Protected Attributes
DtU32	myRequestId
DtInt32	myFrameMode
DtFloat64	myFrameTime
DtU32	myRandomNumberSeed
DtFilename	myComponentAttachmentTableName
DtFilename	myTerrainFileName
DtFilename	myGuiTerrainFilename
DtFilename	myObjParamsFileName
DtFilename	myPlanFileName
DtFilename	myOrderOfBattleFileName
bool	myAutoReorganize
DtFloat64	myTimeMultiplier
DtFloat64	mySimTime
DtFloat64	myExerciseStartTime
std::list< DtString >	myAdditionalOpdFileNames
std::list< DtString >	mySimulationModelSetFileNames
DtFilename	myGlobalPlanFileName
DtFilename	myPhysicalWorldFileName
DtFilename	myForceHostilityFileName
DtFilename	myScenarioExtrasFileName
DtString	myScenarioName
DtRwKeyValueList	myScenarioData

---

Detailed Description

DtIfLoadScenario is a composite message containing all the elements needed to begin a simulation.

Content-Type: DtLoadScenarioMessageType

---

Constructor & Destructor Documentation

DtIfLoadScenario::DtIfLoadScenario

(

)

default constructor

virtual DtIfLoadScenario::~DtIfLoadScenario

(

)

[virtual]

destructor

DtIfLoadScenario::DtIfLoadScenario

(

const DtIfLoadScenario &

orig

)

copy constructor

---

Member Function Documentation

DtIfLoadScenario& DtIfLoadScenario::operator=

(

const DtIfLoadScenario &

orig

)

assignment operator

virtual DtSimInterfaceContent* DtIfLoadScenario::clone

(

)

const [virtual]

Implements DtSimInterfaceContent.

virtual int DtIfLoadScenario::type

(

)

const [virtual]

Implements DtSimInterfaceContent.

virtual const DtFilename& DtIfLoadScenario::componentAttachmentTableFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setComponentAttachmentTableFileName

(

const DtString &

fileName

)

[virtual]

virtual const DtFilename& DtIfLoadScenario::terrainFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setTerrainFileName

(

const DtString &

fileName

)

[virtual]

virtual const DtFilename& DtIfLoadScenario::guiTerrainFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setGuiTerrainFileName

(

const DtString &

fileName

)

[virtual]

virtual const bool& DtIfLoadScenario::autoReorganize

(

)

const [virtual]

virtual void DtIfLoadScenario::setAutoReorganize

(

bool

yesNo

)

[virtual]

virtual double DtIfLoadScenario::timeMultiplier

(

)

const [virtual]

virtual void DtIfLoadScenario::setTimeMultiplier

(

double

timeMultiplier

)

[virtual]

virtual const DtFilename& DtIfLoadScenario::objectParametersFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setObjectParametersFileName

(

const DtString &

fileName

)

[virtual]

virtual const DtFilename& DtIfLoadScenario::physicalWorldFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setPhysicalWorldFileName

(

const DtString &

fileName

)

[virtual]

virtual const DtFilename& DtIfLoadScenario::orderOfBattleFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setOrderOfBattleFileName

(

const DtString &

fileName

)

[virtual]

virtual const DtFilename& DtIfLoadScenario::planFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setPlanFileName

(

const DtString &

fileName

)

[virtual]

virtual unsigned int DtIfLoadScenario::randomNumberSeed

(

)

const [virtual]

virtual void DtIfLoadScenario::setRandomNumberSeed

(

unsigned int

numberSeed

)

[virtual]

virtual int DtIfLoadScenario::frameMode

(

)

const [virtual]

virtual void DtIfLoadScenario::setFrameMode

(

int

frameMode

)

[virtual]

virtual double DtIfLoadScenario::frameTime

(

)

const [virtual]

virtual void DtIfLoadScenario::setFrameTime

(

double

frameTime

)

[virtual]

virtual void DtIfLoadScenario::setSimTime

(

DtTime

time

)

[virtual]

Set/get simulation time.

virtual DtTime DtIfLoadScenario::simTime

(

)

const [virtual]

virtual void DtIfLoadScenario::setExerciseStartTime

(

DtTime

time

)

[virtual]

Set/get exercise start time.

virtual DtTime DtIfLoadScenario::exerciseStartTime

(

)

const [virtual]

virtual unsigned long DtIfLoadScenario::requestId

(

)

const [virtual]

virtual void DtIfLoadScenario::setRequestId

(

unsigned long

requestId

)

[virtual]

virtual std::list<DtString>& DtIfLoadScenario::additionalOpdFileNames

(

)

[virtual]

virtual const std::list<DtString>& DtIfLoadScenario::additionalOpdFileNames

(

)

const [virtual]

virtual std::list<DtString>& DtIfLoadScenario::simulationModelSetFileNames

(

)

[virtual]

virtual const std::list<DtString>& DtIfLoadScenario::simulationModelSetFileNames

(

)

const [virtual]

virtual const DtFilename& DtIfLoadScenario::globalPlanFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setGlobalPlanFileName

(

const DtString &

fileName

)

[virtual]

virtual const DtFilename& DtIfLoadScenario::forceHostilityFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setForceHostilityFileName

(

const DtString &

fileName

)

[virtual]

virtual const DtFilename& DtIfLoadScenario::scenarioExtrasFileName

(

)

const [virtual]

virtual void DtIfLoadScenario::setScenarioExtrasFileName

(

const DtString &

fileName

)

[virtual]

virtual DtString DtIfLoadScenario::scenarioName

(

)

const [virtual]

virtual void DtIfLoadScenario::setScenarioName

(

const DtString &

name

)

[virtual]

virtual const DtRwKeyValueList& DtIfLoadScenario::scenarioData

(

)

const [virtual]

virtual DtRwKeyValueList& DtIfLoadScenario::scenarioData

(

)

[virtual]

virtual void DtIfLoadScenario::setScenarioData

(

const DtRwKeyValueList &

data

)

[virtual]

virtual int DtIfLoadScenario::netRepSize

(

)

const [virtual]

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfLoadScenario::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfLoadScenario::setToNet

(

)

[virtual]

Reimplemented from DtSimInterfaceContent.

virtual void DtIfLoadScenario::printDataToString

(

DtString &

str

)

[virtual]

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfLoadScenario::creator

(

)

[static]

---

Member Data Documentation

DtU32 DtIfLoadScenario::myRequestId [protected]

DtInt32 DtIfLoadScenario::myFrameMode [protected]

DtFloat64 DtIfLoadScenario::myFrameTime [protected]

DtU32 DtIfLoadScenario::myRandomNumberSeed [protected]

DtFilename DtIfLoadScenario::myComponentAttachmentTableName [protected]

DtFilename DtIfLoadScenario::myTerrainFileName [protected]

DtFilename DtIfLoadScenario::myGuiTerrainFilename [protected]

DtFilename DtIfLoadScenario::myObjParamsFileName [protected]

DtFilename DtIfLoadScenario::myPlanFileName [protected]

DtFilename DtIfLoadScenario::myOrderOfBattleFileName [protected]

bool DtIfLoadScenario::myAutoReorganize [protected]

DtFloat64 DtIfLoadScenario::myTimeMultiplier [protected]

DtFloat64 DtIfLoadScenario::mySimTime [protected]

DtFloat64 DtIfLoadScenario::myExerciseStartTime [protected]

std::list<DtString> DtIfLoadScenario::myAdditionalOpdFileNames [protected]

std::list<DtString> DtIfLoadScenario::mySimulationModelSetFileNames [protected]

DtFilename DtIfLoadScenario::myGlobalPlanFileName [protected]

DtFilename DtIfLoadScenario::myPhysicalWorldFileName [protected]

DtFilename DtIfLoadScenario::myForceHostilityFileName [protected]

DtFilename DtIfLoadScenario::myScenarioExtrasFileName [protected]

DtString DtIfLoadScenario::myScenarioName [protected]

DtRwKeyValueList DtIfLoadScenario::myScenarioData [protected]

---

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

• include/vrfmsgs/ifLoadScen.h