DtIfSaveScenario Class Reference

class DtIfSaveScenario: More...

Inheritance diagram for DtIfSaveScenario:

Public Types
enum	Operation { SaveScenario = 0, TakeSnapshot = 1, TakeBaseSnapshot = 2 }

Public Member Functions
	DtIfSaveScenario ()
	default constructor
virtual	~DtIfSaveScenario ()
	destructor
	DtIfSaveScenario (const DtIfSaveScenario &orig)
	copy constructor
DtIfSaveScenario &	operator= (const DtIfSaveScenario &orig)
	assignment operator
virtual int	type () const
	Returns DtSaveScenarioMessageType.
virtual unsigned int	requestId () const
virtual void	setRequestId (unsigned int id)
virtual DtInetAddr	address () const
virtual void	setAddress (DtInetAddr a)
virtual int	port () const
virtual void	setPort (int p)
virtual DtSimInterfaceContent *	clone () const
virtual void	printDataToString (DtString &str)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	setOperation (Operation)
Operation	operation () const
virtual void	setSaveCheckpoint (bool)
bool	saveCheckpoint () const
virtual void	setScenarioFilename (const DtFilename &)
virtual const DtFilename &	scenarioFilename () const
virtual void	setSimTime (double)
	IF this is a checkpoint saved AND the sim time is >= 0 then it will save the given checkpoint to disk and send the information to the front-end as if this were a normal scenario save.
virtual double	simTime () 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	myPort
DtInetAddr	myAddress
Operation	myOperation
bool	mySaveCheckpoint
double	mySimTime
DtFilename	myScenarioFilename
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

Detailed Description

class DtIfSaveScenario:

DtIfSaveScenario is sent from the front end to tell the backend that it needs to save (and sent) its portion of the current scenario.

Member Enumeration Documentation

enum DtIfSaveScenario::Operation

Enumerator:

SaveScenario
TakeSnapshot	Default.
TakeBaseSnapshot

Constructor & Destructor Documentation

DtIfSaveScenario::DtIfSaveScenario

(

)

default constructor

virtual DtIfSaveScenario::~DtIfSaveScenario ( )

virtual

destructor

DtIfSaveScenario::DtIfSaveScenario

(

const DtIfSaveScenario &

orig

)

copy constructor

Member Function Documentation

DtIfSaveScenario& DtIfSaveScenario::operator=

(

const DtIfSaveScenario &

orig

)

assignment operator

virtual int DtIfSaveScenario::type ( ) const

virtual

Returns DtSaveScenarioMessageType.

Implements DtSimInterfaceContent.

virtual unsigned int DtIfSaveScenario::requestId ( ) const

virtual

virtual void DtIfSaveScenario::setRequestId ( unsigned int  id )

virtual

virtual DtInetAddr DtIfSaveScenario::address ( ) const

virtual

virtual void DtIfSaveScenario::setAddress ( DtInetAddr  a )

virtual

virtual int DtIfSaveScenario::port ( ) const

virtual

virtual void DtIfSaveScenario::setPort ( int  p )

virtual

virtual DtSimInterfaceContent* DtIfSaveScenario::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual void DtIfSaveScenario::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

virtual int DtIfSaveScenario::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSaveScenario::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfSaveScenario::setOperation ( Operation  )

virtual

Operation DtIfSaveScenario::operation ( ) const

inline

virtual void DtIfSaveScenario::setSaveCheckpoint ( bool  )

virtual

bool DtIfSaveScenario::saveCheckpoint ( ) const

inline

virtual void DtIfSaveScenario::setScenarioFilename ( const DtFilename &  )

virtual

virtual const DtFilename& DtIfSaveScenario::scenarioFilename ( ) const

virtual

virtual void DtIfSaveScenario::setSimTime ( double  )

virtual

IF this is a checkpoint saved AND the sim time is >= 0 then it will save the given checkpoint to disk and send the information to the front-end as if this were a normal scenario save.

virtual double DtIfSaveScenario::simTime ( ) const

virtual

static DtSimInterfaceContent* DtIfSaveScenario::creator ( )

static

Member Data Documentation

DtU32 DtIfSaveScenario::myRequestId

protected

DtU32 DtIfSaveScenario::myPort

protected

DtInetAddr DtIfSaveScenario::myAddress

protected

Operation DtIfSaveScenario::myOperation

protected

bool DtIfSaveScenario::mySaveCheckpoint

protected

double DtIfSaveScenario::mySimTime

protected

DtFilename DtIfSaveScenario::myScenarioFilename

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfmsgs/ifSaveScenario.h