DtIfSaveComplete Class Reference

DtIfSaveComplete is sent from the backend whenever it completes a save. It contains the data about the saved scenario.

Inheritance diagram for DtIfSaveComplete:

Public Member Functions
	DtIfSaveComplete ()
virtual	~DtIfSaveComplete ()
	DtIfSaveComplete (const DtIfSaveComplete &orig)
DtIfSaveComplete &	operator= (const DtIfSaveComplete &orig)
virtual int	type () const
virtual void	setRequestId (unsigned int id)
virtual unsigned int	requestId () const
virtual void	setResult (DtSaveResult result)
virtual DtSaveResult	result () const
virtual const DtFilename &	terrainFileName () const
virtual void	setTerrainFileName (const DtString &fileName)
virtual const DtFilename &	guiTerrainName () const
virtual void	setGuiTerrainName (const DtString &filename)
virtual const DtFilename &	componentAttachmentTableFileName () const
virtual void	setComponentAttachmentTableFileName (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 void	setRunDurationTime (double)
virtual double	runDurationTime () const
virtual const DtFilename &	planFileName () const
virtual void	setPlanFileName (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 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)
virtual DtTime	simTime () const
virtual void	setExerciseStartTime (DtTime time)
virtual DtTime	exerciseStartTime () const
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 DtString	scenarioName () const
virtual void	setScenarioName (const DtString &name)
virtual DtRwKeyValueList &	scenarioData ()
virtual const DtRwKeyValueList &	scenarioData () const
virtual void	setIsCheckpoint (bool)
virtual bool	isCheckpoint () const
virtual void	setSnapshotRequestSimTimeSave (double)
virtual double	snapshotRequestSimTimeSave () const
virtual DtSimInterfaceContent *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual char *	setToNet (char *)
virtual void	printDataToString (DtString &str)
virtual void	setGuiRuntimeLoadBalancingScheme (const DtString &scheme, const DtString &userData)
virtual void	getGuiRuntimeLoadBalancingScheme (DtString &scheme, DtString &userData) const
virtual void	setSimRemoteAttachmentBalancingScheme (const DtString &scheme, const DtString &userData)
virtual void	getSimRemoteAttachmentBalancingScheme (DtString &scheme, DtString &userData) 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
DtSaveResult	myResult
DtU32	myFrameMode
DtFloat64	myFrameTime
DtU32	myRandomNumberSeed
DtFilename	myTerrainFileName
DtFilename	myComponentAttachmentTableName
DtFilename	myObjParamsFileName
DtFilename	myPhysicalWorldFileName
DtFilename	myPlanFileName
DtFilename	myOrderOfBattleFileName
DtFilename	myScenarioScriptsFilename
DtFilename	myOrbatFilename
DtFilename	myForceHostilityFileName
DtFilename	myScenarioExtrasFileName
bool	myAutoReorganize
DtFloat64	myTimeMultiplier
DtReal	mySimTime
DtReal	myExerciseStartTime
std::list< DtString >	myAdditionalOpdFileNames
std::list< DtString >	mySimulationModelSetFileNames
DtString	myScenarioName
DtRwKeyValueList	myScenarioData
DtFilename	myGuiTerrainName
double	myRunDurationTime
DtString	myGuiRuntimeLoadBalancingScheme
DtString	myGuiRuntimeLoadBalancingSchemeData
DtString	mySimRemoteAttachmentBalancingScheme
DtString	mySimRemoteAttachmentBalancingSchemeData
bool	myIsCheckpoint
DtReal	mySnapshotRequestSimTimeSave
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

DtIfSaveComplete::DtIfSaveComplete

(

)

default constructor

virtual DtIfSaveComplete::~DtIfSaveComplete ( )

virtual

destructor

DtIfSaveComplete::DtIfSaveComplete

(

const DtIfSaveComplete &

orig

)

copy constructor

Member Function Documentation

DtIfSaveComplete& DtIfSaveComplete::operator=

(

const DtIfSaveComplete &

orig

)

assignment operator

virtual int DtIfSaveComplete::type ( ) const

virtual

Returns DtSaveScenarioMessageType.

Implements DtSimInterfaceContent.

virtual void DtIfSaveComplete::setRequestId ( unsigned int  id )

virtual

Set/Get the request id.

virtual unsigned int DtIfSaveComplete::requestId ( ) const

virtual

virtual void DtIfSaveComplete::setResult ( DtSaveResult  result )

virtual

Set/Get save result.

virtual DtSaveResult DtIfSaveComplete::result ( ) const

virtual

virtual const DtFilename& DtIfSaveComplete::terrainFileName ( ) const

virtual

virtual void DtIfSaveComplete::setTerrainFileName ( const DtString &  fileName )

virtual

virtual const DtFilename& DtIfSaveComplete::guiTerrainName ( ) const

virtual

virtual void DtIfSaveComplete::setGuiTerrainName ( const DtString &  filename )

virtual

virtual const DtFilename& DtIfSaveComplete::componentAttachmentTableFileName ( ) const

virtual

virtual void DtIfSaveComplete::setComponentAttachmentTableFileName ( const DtString &  fileName )

virtual

virtual const bool& DtIfSaveComplete::autoReorganize ( ) const

virtual

virtual void DtIfSaveComplete::setAutoReorganize ( bool  yesNo )

virtual

virtual double DtIfSaveComplete::timeMultiplier ( ) const

virtual

virtual void DtIfSaveComplete::setTimeMultiplier ( double  timeMultiplier )

virtual

virtual const DtFilename& DtIfSaveComplete::objectParametersFileName ( ) const

virtual

virtual void DtIfSaveComplete::setObjectParametersFileName ( const DtString &  fileName )

virtual

virtual const DtFilename& DtIfSaveComplete::physicalWorldFileName ( ) const

virtual

virtual void DtIfSaveComplete::setPhysicalWorldFileName ( const DtString &  fileName )

virtual

virtual const DtFilename& DtIfSaveComplete::orderOfBattleFileName ( ) const

virtual

virtual void DtIfSaveComplete::setOrderOfBattleFileName ( const DtString &  fileName )

virtual

virtual const DtFilename& DtIfSaveComplete::scenarioScriptsFileName ( ) const

virtual

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

virtual

virtual const DtFilename& DtIfSaveComplete::orbatFileName ( ) const

virtual

virtual void DtIfSaveComplete::setOrbatFileName ( const DtString &  fileName )

virtual

virtual void DtIfSaveComplete::setRunDurationTime ( double  )

virtual

virtual double DtIfSaveComplete::runDurationTime ( ) const

virtual

virtual const DtFilename& DtIfSaveComplete::planFileName ( ) const

virtual

virtual void DtIfSaveComplete::setPlanFileName ( const DtString &  fileName )

virtual

virtual const DtFilename& DtIfSaveComplete::forceHostilityFileName ( ) const

virtual

virtual void DtIfSaveComplete::setForceHostilityFileName ( const DtString &  fileName )

virtual

virtual const DtFilename& DtIfSaveComplete::scenarioExtrasFileName ( ) const

virtual

virtual void DtIfSaveComplete::setScenarioExtrasFileName ( const DtString &  fileName )

virtual

virtual unsigned int DtIfSaveComplete::randomNumberSeed ( ) const

virtual

virtual void DtIfSaveComplete::setRandomNumberSeed ( unsigned int  numberSeed )

virtual

virtual int DtIfSaveComplete::frameMode ( ) const

virtual

virtual void DtIfSaveComplete::setFrameMode ( int  frameMode )

virtual

virtual double DtIfSaveComplete::frameTime ( ) const

virtual

virtual void DtIfSaveComplete::setFrameTime ( double  frameTime )

virtual

virtual void DtIfSaveComplete::setSimTime ( DtTime  time )

virtual

Set/get simulation time.

virtual DtTime DtIfSaveComplete::simTime ( ) const

virtual

virtual void DtIfSaveComplete::setExerciseStartTime ( DtTime  time )

virtual

Set/get exercise start time.

virtual DtTime DtIfSaveComplete::exerciseStartTime ( ) const

virtual

virtual std::list<DtString>& DtIfSaveComplete::additionalOpdFileNames ( )

virtual

virtual const std::list<DtString>& DtIfSaveComplete::additionalOpdFileNames ( ) const

virtual

virtual void DtIfSaveComplete::setGuiRuntimeLoadBalancingScheme ( const DtString &  scheme, const DtString &  userData  )

virtual

The runtime load balancing scheme is what is used by the front-end to balance entities being created. Since every front-end must use this scheme is it part of the scenario and transmitted over the network as part of the status message. When the scheme is received the remote controller will get the scheme from the load balancing factory and set it as the scheme for creating of new objects.

virtual void DtIfSaveComplete::getGuiRuntimeLoadBalancingScheme ( DtString &  scheme, DtString &  userData  ) const

virtual

The runtime load balancing scheme is what is used by the front-end to balance entities being created. Since every front-end must use this scheme is it part of the scenario and transmitted over the network as part of the status message. When the scheme is received the remote controller will get the scheme from the load balancing factory and set it as the scheme for creating of new objects.

virtual void DtIfSaveComplete::setSimRemoteAttachmentBalancingScheme ( const DtString &  scheme, const DtString &  userData  )

virtual

The remote attachment balancing scheme is used to place objects on a particular back-end that are available for remote configuration. This is used in conjunction with the component attachment table.

virtual void DtIfSaveComplete::getSimRemoteAttachmentBalancingScheme ( DtString &  scheme, DtString &  userData  ) const

virtual

The remote attachment balancing scheme is used to place objects on a particular back-end that are available for remote configuration. This is used in conjunction with the component attachment table.

virtual std::list<DtString>& DtIfSaveComplete::simulationModelSetFileNames ( )

virtual

virtual const std::list<DtString>& DtIfSaveComplete::simulationModelSetFileNames ( ) const

virtual

virtual DtString DtIfSaveComplete::scenarioName ( ) const

virtual

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

virtual

virtual DtRwKeyValueList& DtIfSaveComplete::scenarioData ( )

virtual

virtual const DtRwKeyValueList& DtIfSaveComplete::scenarioData ( ) const

virtual

virtual void DtIfSaveComplete::setIsCheckpoint ( bool  )

virtual

virtual bool DtIfSaveComplete::isCheckpoint ( ) const

virtual

virtual void DtIfSaveComplete::setSnapshotRequestSimTimeSave ( double  )

virtual

virtual double DtIfSaveComplete::snapshotRequestSimTimeSave ( ) const

virtual

virtual DtSimInterfaceContent* DtIfSaveComplete::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual int DtIfSaveComplete::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSaveComplete::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSaveComplete::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual char* DtIfSaveComplete::setToNet ( char *  )

virtual

virtual void DtIfSaveComplete::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfSaveComplete::creator ( )

static

Member Data Documentation

DtU32 DtIfSaveComplete::myRequestId

protected

DtSaveResult DtIfSaveComplete::myResult

protected

DtU32 DtIfSaveComplete::myFrameMode

protected

DtFloat64 DtIfSaveComplete::myFrameTime

protected

DtU32 DtIfSaveComplete::myRandomNumberSeed

protected

DtFilename DtIfSaveComplete::myTerrainFileName

protected

DtFilename DtIfSaveComplete::myComponentAttachmentTableName

protected

DtFilename DtIfSaveComplete::myObjParamsFileName

protected

DtFilename DtIfSaveComplete::myPhysicalWorldFileName

protected

DtFilename DtIfSaveComplete::myPlanFileName

protected

DtFilename DtIfSaveComplete::myOrderOfBattleFileName

protected

DtFilename DtIfSaveComplete::myScenarioScriptsFilename

protected

DtFilename DtIfSaveComplete::myOrbatFilename

protected

DtFilename DtIfSaveComplete::myForceHostilityFileName

protected

DtFilename DtIfSaveComplete::myScenarioExtrasFileName

protected

bool DtIfSaveComplete::myAutoReorganize

protected

DtFloat64 DtIfSaveComplete::myTimeMultiplier

protected

DtReal DtIfSaveComplete::mySimTime

protected

DtReal DtIfSaveComplete::myExerciseStartTime

protected

std::list<DtString> DtIfSaveComplete::myAdditionalOpdFileNames

protected

std::list<DtString> DtIfSaveComplete::mySimulationModelSetFileNames

protected

DtString DtIfSaveComplete::myScenarioName

protected

DtRwKeyValueList DtIfSaveComplete::myScenarioData

protected

DtFilename DtIfSaveComplete::myGuiTerrainName

protected

double DtIfSaveComplete::myRunDurationTime

protected

DtString DtIfSaveComplete::myGuiRuntimeLoadBalancingScheme

protected

DtString DtIfSaveComplete::myGuiRuntimeLoadBalancingSchemeData

protected

DtString DtIfSaveComplete::mySimRemoteAttachmentBalancingScheme

protected

DtString DtIfSaveComplete::mySimRemoteAttachmentBalancingSchemeData

protected

bool DtIfSaveComplete::myIsCheckpoint

protected

DtReal DtIfSaveComplete::mySnapshotRequestSimTimeSave

protected

---

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

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