DtCulturalFeatureSetController Class Reference

DtCulturalFeatureSetController is a controller component responsible for handling DtSetDataRequests for cultural features. More...

Inheritance diagram for DtCulturalFeatureSetController:

Public Member Functions
	DtCulturalFeatureSetController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtCulturalFeatureSetController ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	processSetAltitude (DtSimMessage *msg)
Public Member Functions inherited from DtLocalEntitySetController
	DtLocalEntitySetController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtLocalEntitySetController ()
	destructor
virtual bool	init ()
	calls createPSR()
virtual void	processSetForce (DtSimMessage *msg)
virtual void	processSetAppearance (DtSimMessage *msg)
virtual void	processSetCapabilities (DtSimMessage *msg)
virtual void	processSetResource (DtSimMessage *msg)
virtual void	processSetSOR (DtSimMessage *msg)
virtual void	processSetSpeed (DtSimMessage *msg)
virtual void	processSetEngagementRules (DtSimMessage *msg)
virtual void	processSetRestore (DtSimMessage *msg)
virtual void	processSetConcealed (DtSimMessage *msg)
virtual void	processSetLocation (DtSimMessage *msg)
	Verifies that the message contains a DtSetLocationRequest and if so pulls the requested location out of the message.
virtual void	setLocation (DtVector geocentricLocation)
	Converts geocentricLocation to local coordinates and then provides them to myLocalEntity->place.
virtual void	processSetHeading (DtSimMessage *msg)
	Verifies that the message contains a DtSetHeadingRequest and if so pulls the requested heading out of the message.
virtual void	setHeading (DtReal heading)
	Calls place on myLocalEntity with the requested heading.
virtual void	enable ()
	Override to (re)add set data request callbacks.
virtual void	disable ()
	Override to remove set data request callbacks.
virtual void	tick ()
	Checks the #myPendingSetLocationRequest and if the terrain is available the location in #myPendingSetLocationRequest setLocation is called.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimBaseRadio *	radio ()
	The radio this component is listening to.
virtual void	taskNotify (const DtSimTask &task)
	This is used by the entity to notify all controllers that a new task has been received.
virtual void	clearTask ()
	Called when you want to clear out this component's task state.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
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 actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
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 DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Static Public Member Functions inherited from DtLocalEntitySetController
static void	setHeadingCallback (DtSimMessage *msg, void *usrData)
static void	setForceCallback (DtSimMessage *msg, void *usrData)
static void	setLocationCallback (DtSimMessage *msg, void *usrData)
static void	setAppearanceCallback (DtSimMessage *msg, void *usrData)
static void	setCapabilitiesCallback (DtSimMessage *msg, void *usrData)
static void	setAltitudeCallback (DtSimMessage *msg, void *usrData)
static void	setResourceCallback (DtSimMessage *msg, void *usrData)
static void	setSORCallback (DtSimMessage *msg, void *usrData)
static void	setSpeedCallback (DtSimMessage *msg, void *usrData)
static void	setEngagementRulesCallback (DtSimMessage *msg, void *usrData)
static void	setRestoreCallback (DtSimMessage *msg, void *usrData)
static void	setConcealedCallback (DtSimMessage *msg, void *usrData)

Protected Member Functions
	DtCulturalFeatureSetController ()
	default constructor; should not be called.
	DtCulturalFeatureSetController (const DtCulturalFeatureSetController &orig)
	copy constructor
const DtCulturalFeatureSetController &	operator= (const DtCulturalFeatureSetController &orig)
	assignment operator
Protected Member Functions inherited from DtLocalEntitySetController
	DtLocalEntitySetController ()
	Default constructor; should not be called.
	DtLocalEntitySetController (const DtLocalEntitySetController &orig)
	copy constructor
const DtLocalEntitySetController &	operator= (const DtLocalEntitySetController &orig)
	assignment operator
virtual void	setRadio (DtSimRadio *radio)
	Overrides this so it can register its interest in the set commands.
virtual void	addSetDataCallbacks ()
	Add set data request callbacks.
void	removeSetDataCallbacks ()
	Callbacks are removed when component is disabled or destroyed.
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
Protected Member Functions inherited from DtSimComponent
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
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.

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 Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Protected Attributes inherited from DtLocalEntitySetController
DtVrfObject *	myLocalEntity
	Cached pointer to parent object.
DtLocalEntitySetControllerPSR *	myProcessState
	Container for state data associated with this component.
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtCulturalFeatureSetController is a controller component responsible for handling DtSetDataRequests for cultural features.

End User Description: The DtCulturalFeatureSetController controller component handles all of DtSetDataRequest messages that the DtLocalEntitySetController, but handles DtSetAltitudeRequests in a way more appropriate for cultural features. Specifically, it handles set altitude requests differently. If the cultural feature is gravity aligned, then it does not clamp to terrain. Otherwise, it does.

Developer Description: Instances of DtCulturalFeatureSetController derive from DtLocalEntitySetController, which register for all the set messages that affect a local entity and set the state repository as appropriate. In addition, it registers for and processes set altitude messages. When it receives a set altitude message, if the cultural feature is configured to be gravity-aligned (it checks its state repository), then it respects the altitude in the message. Otherwise, it clamps to the ground.

Uses Descriptor Type: DtComponentDescriptor

Constructor & Destructor Documentation

DtCulturalFeatureSetController::DtCulturalFeatureSetController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtCulturalFeatureSetController::~DtCulturalFeatureSetController ( )

virtual

destructor

DtCulturalFeatureSetController::DtCulturalFeatureSetController ( )

protected

default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtCulturalFeatureSetController::DtCulturalFeatureSetController ( const DtCulturalFeatureSetController &  orig )

protected

copy constructor

Member Function Documentation

virtual DtString DtCulturalFeatureSetController::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns

DtCulturalFeatureSetControllerType

Reimplemented from DtLocalEntitySetController.

virtual void DtCulturalFeatureSetController::processSetAltitude ( DtSimMessage *  msg )

virtual

Reimplemented from DtLocalEntitySetController.

static DtSimComponent* DtCulturalFeatureSetController::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

Reimplemented from DtLocalEntitySetController.

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

protected

assignment operator

---

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

• include/vrfmodel/culturalFeatureSetCtlr.h