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

Inheritance diagram for DtAggregateEmbarkationDescriptor:

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.
Public Member Functions inherited from DtEmbarkationDescriptor
	DtEmbarkationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtEmbarkationDescriptor (const DtEmbarkationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtEmbarkationDescriptor &	operator= (const DtEmbarkationDescriptor &orig)
	assignment
virtual	~DtEmbarkationDescriptor ()
	destructor
virtual double	responseTimeout () const
	Accessor/mutator for myResponseTimeout.
virtual void	setResponseTimeout (double value)
	Accessor/mutator for myResponseTimeout.
virtual int	responseRetries () const
	Accessor/mutator for myResponseRetries.
virtual void	setResponseRetries (int value)
	Accessor/mutator for myResponseRetries.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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.
Protected Attributes inherited from DtEmbarkationDescriptor
DtRwReal	myResponseTimeout
	Parameter Name: response-timeout Parameter Description: Should set the timeout period for waiting for a response for request for embarkation before making another request.
DtRwInt	myResponseRetries
	Parameter Name: response-retries Parameter Description: Sets the number of retries for sending an embarkation response request.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtAggregateEmbarkationDescriptor ()
	default constructor; not implemented

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation