DtSetSwitchSystem Class Reference

Set data request for switching out one system for another for the entity. More...

Inheritance diagram for DtSetSwitchSystem:

List of all members.

Public Member Functions
	DtSetSwitchSystem ()
	default constructor
	DtSetSwitchSystem (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetSwitchSystem (const DtString &writeName, const DtSetSwitchSystem &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetSwitchSystem &	operator= (const DtSetSwitchSystem &orig)
	assignment operator
virtual	~DtSetSwitchSystem ()
virtual int	type () const
	Returns DtSetSwitchSystemType.
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of the request.
virtual DtString	stringRep () const
	Get a readable string representation of this setDataRequest.
virtual const DtString &	systemCategory () const
	The name of the system category in which to switch systems.
virtual void	setSystemCategory (const DtString &cat)
	The name of the system category in which to switch systems.
DtRwString	mySystemCategory
	The name of the system to activate.
DtRwString	mySystemToTurnOn
	The name of the system to activate.
DtRwString	mySystemToSwitchOff
	The name of the system to activate.
virtual const DtString &	systemToActivateName () const
	The name of the system to activate.
virtual void	setSystemToActivateName (const DtString &activeSys)
	The name of the system to activate.
virtual const DtString &	systemToDeactivateName () const
	The name of the system to deactivate.
virtual void	setSystemToDeactivateName (const DtString &deactiveSys)
	The name of the system to activate.
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
static DtSetDataRequest *	creator ()
	The name of the system to activate.

---

Detailed Description

Set data request for switching out one system for another for the entity.

DtSetSwitchSystem is used to set the aggregate state for an aggregate entity.

---

Constructor & Destructor Documentation

DtSetSwitchSystem::DtSetSwitchSystem

(

)

default constructor

DtSetSwitchSystem::DtSetSwitchSystem	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetSwitchSystem::DtSetSwitchSystem	(	const DtString &	writeName,
		const DtSetSwitchSystem &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSetSwitchSystem::~DtSetSwitchSystem

(

)

[virtual]

---

Member Function Documentation

const DtSetSwitchSystem& DtSetSwitchSystem::operator=

(

const DtSetSwitchSystem &

orig

)

assignment operator

virtual int DtSetSwitchSystem::type

(

)

const [virtual]

Returns DtSetSwitchSystemType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetSwitchSystem::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetSwitchSystem::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtString& DtSetSwitchSystem::systemCategory

(

)

const [virtual]

The name of the system category in which to switch systems.

virtual void DtSetSwitchSystem::setSystemCategory

(

const DtString &

cat

)

[virtual]

The name of the system category in which to switch systems.

virtual const DtString& DtSetSwitchSystem::systemToActivateName

(

)

const [virtual]

The name of the system to activate.

virtual void DtSetSwitchSystem::setSystemToActivateName

(

const DtString &

activeSys

)

[virtual]

The name of the system to activate.

virtual const DtString& DtSetSwitchSystem::systemToDeactivateName

(

)

const [virtual]

The name of the system to deactivate.

virtual void DtSetSwitchSystem::setSystemToDeactivateName

(

const DtString &

deactiveSys

)

[virtual]

The name of the system to activate.

virtual int DtSetSwitchSystem::netRepSize

(

)

const [virtual]

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSwitchSystem::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetSwitchSystem::setToNet

(

)

[virtual]

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetSwitchSystem::creator

(

)

[static]

The name of the system to activate.

---

Member Data Documentation

DtRwString DtSetSwitchSystem::mySystemCategory [protected]

The name of the system to activate.

DtRwString DtSetSwitchSystem::mySystemToTurnOn [protected]

The name of the system to activate.

DtRwString DtSetSwitchSystem::mySystemToSwitchOff [protected]

The name of the system to activate.

---

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

• include/vrftasks/setSwitchSystem.h