DtIfCloseScenario Class Reference

class DtIfCloseScenario: More...

Inheritance diagram for DtIfCloseScenario:

Public Member Functions
	DtIfCloseScenario ()
	default constructor
virtual	~DtIfCloseScenario ()
	destructor
	DtIfCloseScenario (const DtIfCloseScenario &orig)
	copy constructor
DtIfCloseScenario &	operator= (const DtIfCloseScenario &orig)
	assignment operator
virtual int	type () const
	Returns DtCloseScenarioMessageType.
virtual DtSimInterfaceContent *	clone () const
virtual void	setDatabaseToKeepOpen (const DtFilename &)
	Set this only if you are issuing a close followed by a load.
virtual const DtFilename &	databaseToKeepOpen () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	printDataToString (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
DtFilename	myDatabaseToKeepOpen
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 DtIfCloseScenario:

DtIfCloseScenario is sent from the front end to tell the backend that the user has closed the current scenario. DtIfCloseScenario is the content portion of a close scenario message.

Content-Type: DtCloseScenarioMessageType

Parameters: None.

Constructor & Destructor Documentation

DtIfCloseScenario::DtIfCloseScenario

(

)

default constructor

virtual DtIfCloseScenario::~DtIfCloseScenario ( )

virtual

destructor

DtIfCloseScenario::DtIfCloseScenario

(

const DtIfCloseScenario &

orig

)

copy constructor

Member Function Documentation

DtIfCloseScenario& DtIfCloseScenario::operator=

(

const DtIfCloseScenario &

orig

)

assignment operator

virtual int DtIfCloseScenario::type ( ) const

virtual

Returns DtCloseScenarioMessageType.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfCloseScenario::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual void DtIfCloseScenario::setDatabaseToKeepOpen ( const DtFilename &  )

virtual

Set this only if you are issuing a close followed by a load.

This will be the database that is to come with the next load scenario

virtual const DtFilename& DtIfCloseScenario::databaseToKeepOpen ( ) const

virtual

virtual int DtIfCloseScenario::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfCloseScenario::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfCloseScenario::creator ( )

static

Member Data Documentation

DtFilename DtIfCloseScenario::myDatabaseToKeepOpen

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifCloseScenario.h