DtAggregateEmbarkationDescriptor Class Reference

DtAggregateEmbarkationDescriptor; descriptor for a DtAggregateEmbarkation component. More...

Inheritance diagram for DtAggregateEmbarkationDescriptor:

List of all members.

Public Member Functions
	DtAggregateEmbarkationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAggregateEmbarkationDescriptor (const DtAggregateEmbarkationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtAggregateEmbarkationDescriptor &	operator= (const DtAggregateEmbarkationDescriptor &orig)
	assignment
virtual	~DtAggregateEmbarkationDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	embarkAggregate () const
	Accessor/mutator for myEmbarkAggregate.
virtual void	setEmbarkAggregate (bool)
	Accessor/mutator for myEmbarkAggregate.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myEmbarkAggregate
	Parameter Name: embark-aggregate Parameter Description: Sets whether or not to embark the aggregate at the location of the lead subordinate when all eligible subordinates are embarked.
Private Member Functions
	DtAggregateEmbarkationDescriptor ()
	default constructor; not implemented

---

Detailed Description

DtAggregateEmbarkationDescriptor; descriptor for a DtAggregateEmbarkation component.

Class DtAggregateEmbarkationDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateEmbarkation model component.

End User Description: The DtAggregateEmbarkationDescriptor should only be configured as a part of aggregate entity types (entities configured with a vrf-aggregate-state-repository).

---

Constructor & Destructor Documentation

DtAggregateEmbarkationDescriptor::DtAggregateEmbarkationDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtAggregateEmbarkationDescriptor::DtAggregateEmbarkationDescriptor	(	const DtAggregateEmbarkationDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtAggregateEmbarkationDescriptor::~DtAggregateEmbarkationDescriptor

(

)

[virtual]

destructor

DtAggregateEmbarkationDescriptor::DtAggregateEmbarkationDescriptor

(

)

[private]

default constructor; not implemented

---

Member Function Documentation

DtAggregateEmbarkationDescriptor& DtAggregateEmbarkationDescriptor::operator=

(

const DtAggregateEmbarkationDescriptor &

orig

)

assignment

virtual DtString DtAggregateEmbarkationDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

Used to create the descriptor when read in from an mtl file. Descriptor types are defined in compDescTypes.h

Returns:

DtAggregateEmbarkationDescriptorType

Reimplemented from DtEmbarkationDescriptor.

virtual DtComponentDescriptor* DtAggregateEmbarkationDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Returns:

Newly created copy of this class.

Reimplemented from DtEmbarkationDescriptor.

static DtComponentDescriptor* DtAggregateEmbarkationDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtEmbarkationDescriptor.

virtual bool DtAggregateEmbarkationDescriptor::embarkAggregate

(

)

const [virtual]

Accessor/mutator for myEmbarkAggregate.

virtual void DtAggregateEmbarkationDescriptor::setEmbarkAggregate

(

bool

)

[virtual]

Accessor/mutator for myEmbarkAggregate.

---

Member Data Documentation

DtRwBoolean DtAggregateEmbarkationDescriptor::myEmbarkAggregate [protected]

Parameter Name: embark-aggregate
Parameter Description: Sets whether or not to embark the aggregate at the location of the lead subordinate when all eligible subordinates are embarked.

Parameter Default Value: True

---

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

• include/vrfobjparam/aggregateEmbarkationDesc.h