Class DtAggregateMoveIntoFormationDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateMoveIntoFormationController model component. More...

Inheritance diagram for DtAggregateMoveIntoFormationDescriptor:

[legend]

Public Member Functions
	DtAggregateMoveIntoFormationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtAggregateMoveIntoFormationDescriptor (const DtAggregateMoveIntoFormationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtAggregateMoveIntoFormationDescriptor &	operator= (const DtAggregateMoveIntoFormationDescriptor &orig)
	assignment
virtual	~DtAggregateMoveIntoFormationDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const

virtual bool	stopMovingUponArrival () const
	Accessor/mutator for myStopMovingUponArrival.
virtual void	setStopMovingUponArrival (bool yesNo)
	Accessor/mutator for myStopMovingUponArrival.

virtual bool	turnToHeadingUponArrival () const
	Accessor/mutator for myTurnToHeadingUponArrival.
virtual void	setTurnToHeadingUponArrival (bool yesNo)
	Accessor/mutator for myTurnToHeadingUponArrival.

virtual bool	groundClamp () const
	Accessor/mutator for myGroundClamp.
virtual void	setGroundClamp (bool yesNo)
	Accessor/mutator for myGroundClamp.
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.
bool	operator== (const DtComponentDescriptor &) const
	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.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created 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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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 ()

Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Member Functions
	DtAggregateMoveIntoFormationDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myStopMovingUponArrival
	Parameter Name: stop-moving-upon-arrival Parameter Description: Stop moving upon arrival at location.
DtRwBoolean	myTurnToHeadingUponArrival
	Parameter Name: turn-to-heading-upon-arrival Parameter Description: Turn to heading upon arrival at location.
DtRwBoolean	myGroundClamp
	Parameter Name: ground-clamp Parameter Description: Ground-clamp locations.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
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.

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
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

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

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

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtAggregateMoveIntoFormationDescriptor::~DtAggregateMoveIntoFormationDescriptor ( )

virtual

destructor

DtAggregateMoveIntoFormationDescriptor::DtAggregateMoveIntoFormationDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtAggregateMoveIntoFormationDescriptor& DtAggregateMoveIntoFormationDescriptor::operator= ( const DtAggregateMoveIntoFormationDescriptor & orig )

assignment

virtual DtString DtAggregateMoveIntoFormationDescriptor::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: DtAggregateMoveIntoFormationControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual bool DtAggregateMoveIntoFormationDescriptor::stopMovingUponArrival ( ) const

virtual

Accessor/mutator for myStopMovingUponArrival.

virtual void DtAggregateMoveIntoFormationDescriptor::setStopMovingUponArrival ( bool yesNo )

virtual

Accessor/mutator for myStopMovingUponArrival.

virtual bool DtAggregateMoveIntoFormationDescriptor::turnToHeadingUponArrival ( ) const

virtual

Accessor/mutator for myTurnToHeadingUponArrival.

virtual void DtAggregateMoveIntoFormationDescriptor::setTurnToHeadingUponArrival ( bool yesNo )

virtual

Accessor/mutator for myTurnToHeadingUponArrival.

virtual bool DtAggregateMoveIntoFormationDescriptor::groundClamp ( ) const

virtual

Accessor/mutator for myGroundClamp.

virtual void DtAggregateMoveIntoFormationDescriptor::setGroundClamp ( bool yesNo )

virtual

Accessor/mutator for myGroundClamp.

virtual DtComponentDescriptor* DtAggregateMoveIntoFormationDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

virtual

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtAggregateMoveIntoFormationDescriptor::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 DtComponentDescriptor.

Member Data Documentation

DtRwBoolean DtAggregateMoveIntoFormationDescriptor::myStopMovingUponArrival

protected

Parameter Name: stop-moving-upon-arrival
Parameter Description: Stop moving upon arrival at location.

Set this to true if you want your individual subordinates to stop moving (appropriate for ground vehicles and dismounted infantry). Set this to false if this is not needed (or practical, in the case of fixed-wing entities).
Parameter Default Value: False

DtRwBoolean DtAggregateMoveIntoFormationDescriptor::myTurnToHeadingUponArrival

protected

Parameter Name: turn-to-heading-upon-arrival
Parameter Description: Turn to heading upon arrival at location.

Set this to true if you want your subordinates to turn to the given heading upon arrival at the location (appropriate for ground vehicles and DI). Set to false if this is not needed (or practial, as in the case of fixed-wing entities).
Parameter Default Value: False

DtRwBoolean DtAggregateMoveIntoFormationDescriptor::myGroundClamp

protected

Parameter Name: ground-clamp
Parameter Description: Ground-clamp locations.

Ground-vehicles and human aggregates should set this value to true. Fixed-wing and rotary-wing entities should set this value to false.
Parameter Default Value: True

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/aggregateMoveIntoFormDesc.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation