DtSetAggregateState Class Reference

Set data request for setting an aggregate's state (DtAggregated, DtDisaggregated) More...

Inheritance diagram for DtSetAggregateState:

List of all members.

Public Member Functions
	DtSetAggregateState ()
	default constructor
	DtSetAggregateState (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a request 'put' itself, the writeName will preface it.
	DtSetAggregateState (const DtString &writeName, const DtSetAggregateState &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSetAggregateState &	operator= (const DtSetAggregateState &orig)
	assignment operator
virtual	~DtSetAggregateState ()
virtual int	type () const
	Returns DtSetAggregateStateType.
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.
DtRwAggregateState	myAggregateState
	Aggregate state. Default is DtAggregateStateOther.
virtual enum DtAggregateState	aggregateState () const
	Aggregate state. Default is DtAggregateStateOther.
virtual void	setAggregateState (enum DtAggregateState aggState)
	Aggregate state. Default is DtAggregateStateOther.
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 ()
	Aggregate state. Default is DtAggregateStateOther.

---

Detailed Description

Set data request for setting an aggregate's state (DtAggregated, DtDisaggregated)

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

---

Constructor & Destructor Documentation

DtSetAggregateState::DtSetAggregateState

(

)

default constructor

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

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

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

copy constructor

virtual DtSetAggregateState::~DtSetAggregateState

(

)

[virtual]

---

Member Function Documentation

const DtSetAggregateState& DtSetAggregateState::operator=

(

const DtSetAggregateState &

orig

)

assignment operator

virtual int DtSetAggregateState::type

(

)

const [virtual]

Returns DtSetAggregateStateType.

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetAggregateState::stringRep

(

)

const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual enum DtAggregateState DtSetAggregateState::aggregateState

(

)

const [virtual]

Aggregate state. Default is DtAggregateStateOther.

virtual void DtSetAggregateState::setAggregateState

(

enum DtAggregateState

aggState

)

[virtual]

Aggregate state. Default is DtAggregateStateOther.

virtual int DtSetAggregateState::netRepSize

(

)

const [virtual]

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

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetAggregateState::setToNet

(

)

[virtual]

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

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetAggregateState::creator

(

)

[static]

Aggregate state. Default is DtAggregateStateOther.

---

Member Data Documentation

DtRwAggregateState DtSetAggregateState::myAggregateState [protected]

Aggregate state. Default is DtAggregateStateOther.

---

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

• include/vrftasks/setAggregateState.h