DtIfCloseScenario Class Reference

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.

Inheritance diagram for DtIfCloseScenario:

Public Member Functions
	DtIfCloseScenario ()
virtual	~DtIfCloseScenario () override
	DtIfCloseScenario (const DtIfCloseScenario &orig)
DtIfCloseScenario &	operator= (const DtIfCloseScenario &orig)
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual void	setDatabaseToKeepOpen (const DtFilename &)
virtual const DtFilename &	databaseToKeepOpen () const
virtual void	setForceCloseAll (bool)
virtual bool	forceCloseAll () const
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
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
bool	myForceCloseAll
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

DtIfCloseScenario::DtIfCloseScenario

(

)

default constructor

virtual DtIfCloseScenario::~DtIfCloseScenario ( )

overridevirtual

destructor

DtIfCloseScenario::DtIfCloseScenario

(

const DtIfCloseScenario &

orig

)

copy constructor

Member Function Documentation

DtIfCloseScenario& DtIfCloseScenario::operator=

(

const DtIfCloseScenario &

orig

)

assignment operator

virtual int DtIfCloseScenario::type ( ) const

overridevirtual

Returns DtCloseScenarioMessageType.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfCloseScenario::clone ( ) const

overridevirtual

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 void DtIfCloseScenario::setForceCloseAll ( bool  )

virtual

Normally, if the scenario is closed and there are snapshots and the database to open is the same database opened in the back-end the database will stay open. If you want to force a closing of everything in the case of snapshots being present, pass the forceCloseAll flag as true. If the database to open is supplied and the forceCloseAll flag is true, only the snapshots will be removed if the database to open is the same database that is currently opened.

virtual bool DtIfCloseScenario::forceCloseAll ( ) const

virtual

virtual int DtIfCloseScenario::netRepSize ( ) const

overridevirtual

Reimplemented from DtSimInterfaceContent.

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

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfCloseScenario::setToNet ( )

overridevirtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfCloseScenario::creator ( )

static

Member Data Documentation

DtFilename DtIfCloseScenario::myDatabaseToKeepOpen

protected

bool DtIfCloseScenario::myForceCloseAll

protected

---

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

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