DtIfLoadScenario Class Reference

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

Content-Type: DtLoadScenarioMessageType

Inheritance diagram for DtIfLoadScenario:

Public Member Functions
	DtIfLoadScenario ()
virtual	~DtIfLoadScenario ()
	DtIfLoadScenario (const DtIfLoadScenario &orig)
DtIfLoadScenario &	operator= (const DtIfLoadScenario &orig)
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 &	scenarioScriptsFileName () const
virtual void	setScenarioScriptsFileName (const DtString &fileName)
virtual const DtFilename &	orbatFileName () const
virtual void	setOrbatFileName (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	setImportScenario (bool)
virtual bool	importScenario () const
virtual void	setSimTime (DtTime time)
virtual DtTime	simTime () const
virtual void	setExerciseStartTime (DtTime time)
virtual DtTime	exerciseStartTime () const
virtual void	setRunDurationTime (double)
virtual double	runDurationTime () 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 const DtString &	scenarioName () const
virtual void	setScenarioName (const DtString &name)
virtual void	setScenarioFilename (const DtFilename &)
virtual const DtFilename &	scenarioFilename () const
virtual const DtRwKeyValueList &	scenarioData () const
virtual DtRwKeyValueList &	scenarioData ()
virtual void	setScenarioData (const DtRwKeyValueList &data)
virtual void	setOrbatEnabled (bool b)
virtual bool	orbatEnabled () const
virtual void	setCreateGlobalEnvironment (bool b)
virtual bool	createGlobalEnvironment () const
virtual void	setCreateGlobalDynamicTerrain (bool b)
virtual bool	createGlobalDynamicTerrain () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual void	setScenarioRunId (int)
virtual int	scenarioRunId () const
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtU32	myRequestId
DtU32	myFrameMode
DtFloat64	myFrameTime
DtU32	myRandomNumberSeed
bool	myImportScenario
DtFilename	myComponentAttachmentTableName
DtFilename	myTerrainFileName
DtFilename	myGuiTerrainFilename
DtFilename	myObjParamsFileName
DtFilename	myPlanFileName
DtFilename	myOrderOfBattleFileName
DtFilename	myScenarioScriptsFilename
DtFilename	myOrbatFilename
DtFilename	myScenarioFilename
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
double	myRunDurationTime
DtU32	myScenarioRunId
bool	myOrbatEnabled
bool	myCreateGlobalEnvironment
bool	myCreateGlobalDynamicTerrain
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

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::scenarioScriptsFileName ( ) const

virtual

virtual void DtIfLoadScenario::setScenarioScriptsFileName ( const DtString &  fileName )

virtual

virtual const DtFilename& DtIfLoadScenario::orbatFileName ( ) const

virtual

virtual void DtIfLoadScenario::setOrbatFileName ( 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::setImportScenario ( bool  )

virtual

virtual bool DtIfLoadScenario::importScenario ( ) const

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 void DtIfLoadScenario::setRunDurationTime ( double  )

virtual

virtual double DtIfLoadScenario::runDurationTime ( ) 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 const DtString& DtIfLoadScenario::scenarioName ( ) const

virtual

virtual void DtIfLoadScenario::setScenarioName ( const DtString &  name )

virtual

virtual void DtIfLoadScenario::setScenarioFilename ( const DtFilename &  )

virtual

virtual const DtFilename& DtIfLoadScenario::scenarioFilename ( ) const

virtual

virtual const DtRwKeyValueList& DtIfLoadScenario::scenarioData ( ) const

virtual

virtual DtRwKeyValueList& DtIfLoadScenario::scenarioData ( )

virtual

virtual void DtIfLoadScenario::setScenarioData ( const DtRwKeyValueList &  data )

virtual

virtual void DtIfLoadScenario::setOrbatEnabled ( bool  b )

virtual

Whether or not this back-end is enabled to handle orbat messages.

virtual bool DtIfLoadScenario::orbatEnabled ( ) const

virtual

virtual void DtIfLoadScenario::setCreateGlobalEnvironment ( bool  b )

virtual

Whether or not this back-end should create the global environment object.

virtual bool DtIfLoadScenario::createGlobalEnvironment ( ) const

virtual

virtual void DtIfLoadScenario::setCreateGlobalDynamicTerrain ( bool  b )

virtual

Whether or not this back-end should create the global dynamic terrain server object.

virtual bool DtIfLoadScenario::createGlobalDynamicTerrain ( ) const

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

virtual void DtIfLoadScenario::setScenarioRunId ( int  )

virtual

An ID that is used to now uniquely identify messages sent with this scenario rollback. Used to try and prevent messages from a previous scenario interfering with the new. The scenario run id is set to 0, unless set with some number.

virtual int DtIfLoadScenario::scenarioRunId ( ) const

virtual

Member Data Documentation

DtU32 DtIfLoadScenario::myRequestId

protected

DtU32 DtIfLoadScenario::myFrameMode

protected

DtFloat64 DtIfLoadScenario::myFrameTime

protected

DtU32 DtIfLoadScenario::myRandomNumberSeed

protected

bool DtIfLoadScenario::myImportScenario

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

DtFilename DtIfLoadScenario::myScenarioScriptsFilename

protected

DtFilename DtIfLoadScenario::myOrbatFilename

protected

DtFilename DtIfLoadScenario::myScenarioFilename

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

double DtIfLoadScenario::myRunDurationTime

protected

DtU32 DtIfLoadScenario::myScenarioRunId

protected

bool DtIfLoadScenario::myOrbatEnabled

protected

bool DtIfLoadScenario::myCreateGlobalEnvironment

protected

bool DtIfLoadScenario::myCreateGlobalDynamicTerrain

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmsgs/ifLoadScenario.h