DtIfSaveComplete Class Reference

DtIfSaveComplete is sent from the backend whenever it completes a save. More...

Inheritance diagram for DtIfSaveComplete:

List of all members.

Public Member Functions
	DtIfSaveComplete ()
	default constructor
virtual	~DtIfSaveComplete ()
	destructor
	DtIfSaveComplete (const DtIfSaveComplete &orig)
	copy constructor
DtIfSaveComplete &	operator= (const DtIfSaveComplete &orig)
	assignment operator
virtual int	type () const
	Returns DtSaveScenarioMessageType.
virtual void	setRequestId (unsigned int id)
	Set/Get the request id.
virtual unsigned int	requestId () const
virtual void	setResult (DtSaveResult result)
	Set/Get save 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 &	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)
	Set/get simulation time.
virtual DtTime	simTime () const
virtual void	setExerciseStartTime (DtTime time)
	Set/get exercise start 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 DtFilename	globalPlanFileName () const
virtual void	setGlobalPlanFileName (const DtString &filename)
virtual DtString	scenarioName () const
virtual void	setScenarioName (const DtString &name)
virtual DtRwKeyValueList &	scenarioData ()
virtual const DtRwKeyValueList &	scenarioData () const
virtual DtSimInterfaceContent *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	setToNet (char *)
virtual void	printDataToString (DtString &str)
Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Protected Attributes
DtU32	myRequestId
DtSaveResult	myResult
DtInt32	myFrameMode
DtFloat64	myFrameTime
DtU32	myRandomNumberSeed
DtFilename	myTerrainFileName
DtFilename	myComponentAttachmentTableName
DtFilename	myObjParamsFileName
DtFilename	myPhysicalWorldFileName
DtFilename	myPlanFileName
DtFilename	myGlobalPlanFileName
DtFilename	myOrderOfBattleFileName
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

---

Detailed Description

DtIfSaveComplete is sent from the backend whenever it completes a save.

It contains the data about the saved scenario.

---

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::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 std::list<DtString>& DtIfSaveComplete::simulationModelSetFileNames

(

)

[virtual]

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

(

)

const [virtual]

virtual DtFilename DtIfSaveComplete::globalPlanFileName

(

)

const [virtual]

virtual void DtIfSaveComplete::setGlobalPlanFileName

(

const DtString &

filename

)

[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 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 void 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]

DtInt32 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::myGlobalPlanFileName [protected]

DtFilename DtIfSaveComplete::myOrderOfBattleFileName [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]

---

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

• include/vrfmsgs/ifSaveComplete.h