The DtSimComponent class is the base class for the entire simulation model component hierarchy. More...

Inheritance diagram for DtSimComponent:

Public Member Functions
	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	init ()
	Calls createPorts and createPortGroups Initializes myLastTickSimTime.
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	tick ()
	This gives the thread of control to the component.
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 DtString	type () const
	Returns a string identifies the class type of component.
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 void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
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 DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtVrfObject owner, DtSimManager simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Creates a DtSimComponent using the factory, then initializes it via the MTL stream.
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key.
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.

Protected Types
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 Member Functions
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.

Protected Attributes
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptor *	myComponentDescriptor
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.

Static Protected Attributes
static DtSimComponentFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Private Member Functions
	DtSimComponent ()
	default constructor; should not be called.
	DtSimComponent (const DtSimComponent &orig)
	copy constructor, not implemented
DtSimComponent &	operator= (const DtSimComponent &orig)
	assignment operator, 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

Detailed Description

The DtSimComponent class is the base class for the entire simulation model component hierarchy.

****** NOTE of API change for version 3.7 ****** Due to a performance enhancement change, the myComponentDescriptor member variable is now defined to be const and all access to this descriptor (including the componentDescriptor() method) have been changed to be const access. If you have used this descriptor to modify values within the descriptor (either in the original descriptor or a derived descriptor class), this modification will effect all entities that share this descriptor as this descriptor now points to the original parameter database entry.

If you currently modify member variables in a descriptor class, it is suggested to instead make those member variables part of the component that uses them and modify them there. If you must modify the entries in the component descriptor, instead of using the supplied descriptor pointer, you will need to clone the descriptor entry and work with that clone. You will also need to delete this clone in your component destructor to avoid a memory leak.

Examples

Member Typedef Documentation

typedef std::map<DtString, DtInputPort*> DtSimComponent::DtInputPortMap

protected

typedef std::map<DtString, DtOutputPort*> DtSimComponent::DtOutputPortMap

protected

typedef std::map<DtString, DtInputPortGroup*> DtSimComponent::DtInputPortGroupMap

protected

typedef std::map<DtString, DtOutputPortGroup*> DtSimComponent::DtOutputPortGroupMap

protected

Constructor & Destructor Documentation

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

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).

virtual DtSimComponent::~DtSimComponent ( )

virtual

destructor

DtSimComponent::DtSimComponent ( )

private

default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtSimComponent::DtSimComponent ( const DtSimComponent & orig )

private

copy constructor, not implemented

Member Function Documentation

void DtSimComponent::setParentSystem ( DtComponentSystem * system )

Sets the parent system of this component.

This is called before init() when the component is created. Non-virtual since this will probably be moved to the constructor some day, and we don't want to have users overriding this method.

virtual bool DtSimComponent::init ( )

virtual

Calls createPorts and createPortGroups Initializes myLastTickSimTime.

virtual bool DtSimComponent::postAddComponentsInit ( )

inlinevirtual

Called after all components have been created, initialized and added to the component manager.

Override this function if you need to do any further initialization after all other components have been created.

Reimplemented in DtFixedWingPilotController, DtSurfaceEntityPilotController, DtGroundAutoControllerComponent, DtMissileControllerComponent, DtHumanAcquireController, DtRotaryWingTaskController, DtBombController, DtFixedWingDefaultController, DtGroundMovementChooserController, DtWeaponActuator, DtSurfaceEntityActuator, DtTurretActuatorComponent, DtFixedWingTakeoffController, DtBallisticGunController, DtIndirectFireController, DtAggregateModelResolutionController, DtAggregatedSetController, DtDetonationController, DtFixedWingLandingController, DtBaseWeaponController, DtSwingingPartActuator, DtBaseMountingController, DtMountingAzimuthActuator, and DtMountingElevationActuator.

virtual void DtSimComponent::enable ( )

virtual

Is this component enabled or not.

If enabled, component's tick function will be called, otherwise it will not. Default is true (enabled).

Reimplemented in DtEmbarkationController, DtTaskControllerComponent, DtDisaggregatedFormationController, DtLocalEntitySetController, DtAggregateModelResolutionController, DtAggregatedSetController, and DtSystemSwitcherComponent.

virtual void DtSimComponent::disable ( )

virtual

Is this component enabled or not.

If enabled, component's tick function will be called, otherwise it will not. Default is true (enabled).

Reimplemented in DtEmbarkationController, DtTaskControllerComponent, DtDisaggregatedFormationController, DtLocalEntitySetController, DtAggregateModelResolutionController, DtAggregatedSetController, and DtSystemSwitcherComponent.

virtual bool DtSimComponent::isEnabled ( )

virtual

Is this component enabled or not.

If enabled, component's tick function will be called, otherwise it will not. Default is true (enabled).

virtual void DtSimComponent::setIsEnabled ( bool yesNo )

virtual

Is this component enabled or not.

If enabled, component's tick function will be called, otherwise it will not. Default is true (enabled).

virtual void DtSimComponent::preFirstTickInit ( )

virtual

This function can be overridden to initialize a component before it is ticked for the first time.

The implementation for this function is empty. It is called by timedTick if myFirstTick is true.

Reimplemented in DtTargetSelectionController, BHAVE::DtKynapseController, BHAVE::DtSpawnController, DtDIGuyController, DtRailPathController, DtLauncherController, DtOccupancyDirectorController, DtFixedWingLandingController, DtEmbarkationController, DtRadarObjectSensor, DtBallisticGunController, DtDetonationController, DtReleaseBombController, DtBallisticGun, DtLaunchExpendableResourceController, DtLaserGuidedLauncherController, DtObstructionSensor, DtHumanMoveAlongController, DtFixedWingMoveAlongController, DtLasingController, DtMultipleHitDamageActuator, DtAggregateModelResolutionController, DtRailMovementController, DtIndirectFireActuator, DtAggregatedMoveAlongController, DtGroundMoveAlongControllerComponent, DtIffControllerComponent, and DtScriptMultiTaskController.

virtual void DtSimComponent::tick ( )

virtual

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

virtual void DtSimComponent::postTick ( )

virtual

This function is called immediately after tick() is called.

Implementation in this class does nothing.

Reimplemented in DtTaskControllerComponent, DtMultiTaskControllerComponent, and DtSingleTaskControllerComponent.

virtual void DtSimComponent::timedTick ( )

virtual

This version of tick checks to see if the time to tick has arrived.

It checks to see if myNextTickTime <= currentTime, where current time is either exerciseClock()->approximateElapsedRealTime() or exerciseClock()->simTime() depending on the tick-period-uses-real-time parameter. If true, it calls tick(), then calls postTick(), and then recalculates the next time to call timedTick() (myNextTickTime) by calling calculateNextTickTime().

virtual void DtSimComponent::setMinTickPeriod ( double minTickPeriod )

virtual

specifies a minimum tick period (which can also be thought of as

/ maximum tick rate). This is specified in seconds.

virtual double DtSimComponent::minTickPeriod ( ) const

virtual

access the minimum tick period

virtual void DtSimComponent::setMinTickPeriodVariance ( double minTickPeriodVariance )

virtual

set the variance in the minimum tick time

virtual double DtSimComponent::minTickPeriodVariance ( ) const

virtual

access the variance in the minimum tick period

virtual void DtSimComponent::setNextTickTime ( double nextTickTime )

virtual

The next tick time is normally calculated internally.

setNextTickTime can be used to force a tick (set nextTickTime to exerciseClock()-> approximateElapsedRealTime())

virtual double DtSimComponent::nextTickTime ( ) const

virtual

access the next tick time

virtual double DtSimComponent::calculateNextTickTime ( ) const

virtual

The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.

and +myMinTickPeriodVariance/2. If the exercise clock is paused, the variance is always set to zero to insure that the extra calls to DtFRand() don't prevent repeatability.

virtual double DtSimComponent::calculateFirstTickTime ( ) const

virtual

Returns the first time value that the component should tick at.

This is a randomized interval from the current time up to the tick period of the component. Returns either real time or sim time, depending on the value of the tickPeriodUsesRealTime flag in the descriptor.

virtual DtString DtSimComponent::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.

Reimplemented in DtDisaggregatedConvoyFormationController, DtDamageAdjudicationActuator, DtTargetSelectionController, DtDisaggregatedFormationController, DtRailPathController, DtSurfaceEntityPilotController, DtHumanCollisionAvoidanceController, DtDisaggregatedMoveAlongController, DtObstructionSensor, DtWarheadDetonationActuator, DtGroundCollisionAvoidanceController, DtMultipleHitDamageActuator, DtObjectSensor, BHAVE::DtKynapseGroundPlatformController, DtFixedWingMoveAlongController, DtLauncherController, DtMissileDistractionController, DtEmitterComponent, DtSpotReportGeneratorController, DtDIGuyController, DtVrfObjectDataMessenger, DtWeaponController, DtSimpleRotaryWingPilot, DtWeaponActuator, DtGroundMovementChooserController, DtSurfaceEntityActuator, DtTurretAcquireController, DtUnderFireDeterminationSensor, BHAVE::DtKynapseController, BHAVE::DtKynapseLifeformController, DtRadarObjectSensor, DtSurfaceEntityMoveAlongController, DtSurfaceEntityPatrolRouteController, DtTurretActuatorComponent, DtBallisticGun, DtBombController, DtFixedWingTakeoffController, DtFixedWingPilotController, DtGroundMoveToDestinationControllerComponent, BHAVE::DtBhaveMoveDirectionController, DtBallisticGunController, DtIndirectFireActuator, DtTaskControllerComponent, DtDisaggregatedMoveIntoFormationController, DtSignatureObjectSensor, DtRetreatController, DtAutomotiveActuatorComponent, DtFixedWingActuatorComponent, DtHumanMovementActuator, DtIndirectFireController, DtConvoyTaskController, DtTurretSlewController, DtAggregatedMoveToController, DtBaseWeaponController, DtHumanMoveAlongController, DtOccupancyDirectorController, DtSurfaceEntityPatrolBetweenController, DtAggregateModelResolutionController, DtContactFusionController, DtFixedWingFlyIntoController, DtLasingController, DtOrganizationController, DtAirVehicleWeaponHoldController, DtCruiseMissileLaunchController, DtDetonationController, DtDisaggregatedMoveToLocationController, DtFixedWingFlightCommandController, DtFixedWingLandingController, DtRotaryWingActuatorComponent, DtRotaryWingCollisionAvoidanceController, DtSpotReportReceiver, DtAirVehicleSetController, DtDisaggregatedPatrolAlongController, DtEmbarkationController, DtLauncherActuator, DtCulturalFeatureSetController, DtFallingFromSkyActuatorComponent, DtHumanMoveToController, DtIndirectArtilleryComponent, DtRailMovementController, DtSwingingPartActuator, DtAggregateOrganizationController, DtDisaggregatedEmbarkationController, DtFixedWingDefaultController, DtMissileControllerComponent, DtMissileManeuverActComponent, DtRotaryWingPilotController, DtTopLevelOrganizationController, DtGroundMoveDirectionController, DtRotaryWingTurnToHeadingController, DtSurfaceEntityMoveToLocationController, DtAggregatedPatrolController, DtBombActuator, DtDisaggregatedPatrolBetweenController, DtHumanAcquireController, DtHumanPatrolController, DtIffControllerComponent, DtMovementBasedTerrainPreloadController, DtMissileCollisionActuator, DtRotaryWingFlightCommandController, DtRotaryWingLandingController, BHAVE::DtSpawnController, DtDisaggregatedWaitController, DtFixedWingMoveToController, DtGroundMoveToControllerComponent, DtHumanPostureController, DtLimitExistenceController, DtMissileMoveToControllerComponent, DtRotaryWingPatrolBetweenController, DtShapeBasedTerrainPreloadController, DtTurnAndMoveController, DtDefaultLandingGearController, DtGlobalEnvironmentActuator, DtGroundAutoControllerComponent, DtHumanLauncherAcquireController, DtLocalEntitySetController, DtMissileTrackEntityController, DtSurfaceEntityFollowEntityController, DtBaseMountingController, DtCruiseMissileDefaultController, DtDisaggregatedMoveToController, DtFixedWingJoyFlightController, DtFixedWingPatrolRouteController, DtFixedWingEntitySetController, DtGroundPatrolRouteController, DtRotaryWingMoveAlongControllerComponent, DtRotaryWingPatrolRouteController, DtAutoAggregateDisaggregateController, DtGroundFollowEntityController, DtGroundStopMovingControllerComponent, DtLaserGuidedLauncherController, DtRotaryWingJoyFlightController, DtTurretScanController, DtDisaggregatedTurnToHeadingController, DtGroundInterceptAndDestroyController, DtHumanFollowController, DtLasingMissileTrackController, DtReleaseBombController, DtSurfaceEntityMoveToController, DtDisaggregatedOccupancyDirectorController, DtFixedWingFollowEntityController, DtFixedWingPatrolBetweenController, DtGroundPatrolBetweenController, DtGroundTurnToControllerComponent, DtIntegratedLaserGuidedLauncherController, DtMountingAzimuthActuator, DtRotaryWingFollowEntityController, DtRotaryWingLoiterControllerComponent, DtRotaryWingWaitController, DtWaitController, DtHumanEyepointController, DtMountingElevationActuator, DtRotaryWingTaskController, DtRotaryWingMoveToControllerComponent, DtControllerComponent, DtBallisticGunJoy, DtCruiseMissileMoveAlongController, DtHumanJoystickMovementController, DtHumanSetController, DtHumanWeaponStateActuator, DtAggregatedMoveAlongController, DtDisaggregatedDamageActuator, DtIndirectFireWeaponController, DtTacticalSmokeActuator, DtBallisticGunJoyController, DtDisaggregatedActuator, DtDisaggregatedSetController, DtHumanTurnToController, DtFixedWingEmbarkationController, DtGroundJoyMoveController, DtGroundMoveToLocationControllerComponent, DtHumanAimWeaponController, DtHumanStopMovingController, DtIndividualLifeFormDamageAdjudicationActuator, DtLaunchExpendableResourceController, DtSendRadioMessageController, DtGroundJoyTurretController, DtGroundMoveAlongControllerComponent, DtAggregatedMovementActuator, DtFrictionlessGravityActuator, DtLaunchSmokeController, DtSimpleRadarWarningResponse, DtFixedWingMoveToLocationController, DtMountingController, DtSystemSwitcherComponent, DtVerticalLauncherController, DtTimeKeeperComponent, DtCombatRangeController, DtHumanObstructionSensor, DtRotaryWingEmbarkationController, DtRotaryWingMoveToLocationControllerComponent, MyActuatorComponent, DtScriptMultiTaskController, and DtCompatibilityController.

virtual void DtSimComponent::setEntity ( DtVrfObject * entity )

virtual

The entity's state repository is the place that actuator components make updates and other components look to see our current state.

This provides a basic communication mechanism between components. Having the entity changeable makes it possible to migrate a component from one entity to another... A local copy of the entity's state repository is also made by this call for ease of use.

Reimplemented in DtSimpleRadarWarningReceiver, and DtLaserDetector.

virtual DtSimComponent* DtSimComponent::nextComponent ( )

virtual

List management functions.

virtual DtSimComponent* DtSimComponent::prevComponent ( )

virtual

virtual void DtSimComponent::setListItem ( DtListItem * item )

virtual

Used by DtComponentList.

virtual DtListItem* DtSimComponent::listItem ( )

virtual

virtual void DtSimComponent::putData	(	FILE *	fp,
		int	indentLevel = `0`
	)

virtual

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtSimComponent::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)

virtual

getData is just used to get us past the type in the data stream, since it's not actual stored.

Reimplemented from DtReaderWriter.

virtual void DtSimComponent::addInputPort ( DtInputPort * port )

virtual

Adds this input port to the components input port list so that other components can look it up and attach to it.

virtual void DtSimComponent::removeInputPort ( DtInputPort * port )

virtual

virtual DtInputPort* DtSimComponent::lookupInputPort ( const DtString & portName )

virtual

Returns a pointer to the input port registered on this component with the specified name.

portName can specify a group and port in the form "groupname:portname" which will cause this function to look for the port inside the specified group.

virtual DtList DtSimComponent::inputPortList ( ) const

virtual

Returns the list of DtInputPorts registered on this component.

virtual void DtSimComponent::addOutputPort ( DtOutputPort * port )

virtual

Adds this output port to the components output port list so that other components can look it up and attach to it.

virtual void DtSimComponent::removeOutputPort ( DtOutputPort * port )

virtual

virtual DtOutputPort* DtSimComponent::lookupOutputPort ( const DtString & portName )

virtual

Returns a pointer to the output port registered on this component with the specified name.

portName can specify a group and port in the form "groupname:portname" which will cause this function to look for the port inside the specified group.

virtual DtList DtSimComponent::outputPortList ( ) const

virtual

Returns the list of DtOutputPorts registered on this component.

virtual void DtSimComponent::addInputPortGroup ( DtInputPortGroup * group )

virtual

Adds this input port to the components input port list so that other components can look it up and attach to it.

virtual void DtSimComponent::removeInputPortGroup ( DtInputPortGroup * group )

virtual

virtual DtInputPortGroup* DtSimComponent::lookupInputPortGroup ( const DtString & groupName )

virtual

Returns a pointer the input port group registered on this component with the specified name.

virtual DtList DtSimComponent::inputPortGroupList ( ) const

virtual

Returns the list of DtInputPortGroups registered on this component.

virtual void DtSimComponent::addOutputPortGroup ( DtOutputPortGroup * group )

virtual

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 DtSimComponent::removeOutputPortGroup ( DtOutputPortGroup * group )

virtual

virtual DtOutputPortGroup* DtSimComponent::lookupOutputPortGroup ( const DtString & groupName )

virtual

Returns a pointer the output port group registered on this component with the specified name.

virtual DtList DtSimComponent::outputPortGroupList ( ) const

virtual

Returns the list of DtOutputPortGroups registered on this component.

virtual int DtSimComponent::priority ( ) const

virtual

Return the current connection priority for this component.

This value determines which component will take precedence when multiple connections attempts are active on the same input port. Lower numbers will take precedence. By default, component priorities are based on the order they were listed in the OPD entry, starting with 0.

virtual void DtSimComponent::setPriority ( int priority )

virtual

Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.

By default, component priorities are based on the order they were listed in the OPD entry, starting with 0. It is only necessary to use this method if components are being added or removed after object-creation time.

double DtSimComponent::dT ( ) const

inline

This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.

Note that dT() is not virtual, as it is inlined.

Returns: time in seconds

References myDT.

virtual void DtSimComponent::setDT ( double deltaT )

virtual

Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.

Parameters

Input
deltaT	time in seconds

virtual void DtSimComponent::setComponentDescriptor ( DtComponentDescriptor * componentDescriptor )

virtual

The component descriptor specified in the order of battle file or parameter file that was used to create this component.

It may be derived from and hold component-specific parameter information.

Reimplemented in BHAVE::DtKynapseGroundPlatformController, DtWarheadDetonationActuator, BHAVE::DtKynapseController, BHAVE::DtKynapseLifeformController, DtVrfObjectDataMessenger, DtCruiseMissileLaunchController, DtFixedWingFlyIntoController, DtLaserGuidedLauncherController, DtGroundMoveToDestinationControllerComponent, DtBallisticGunJoy, DtBallisticGunJoyController, DtGroundJoyMoveController, DtGroundJoyTurretController, and DtFixedWingJoyFlightController.

virtual const DtComponentDescriptor* DtSimComponent::componentDescriptor ( ) const

virtual

virtual bool DtSimComponent::tickWhileDestroyed ( ) const

virtual

If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.

Otherwise, tick will only be called when the entity is alive.

Returns: false.

Reimplemented in DtDIGuyController, DtObjectSensor, DtOrganizationController, DtAggregateModelResolutionController, DtActuatorComponent, DtUnderFireDeterminationSensor, DtRailMovementController, DtEmitterComponent, DtSpotReportReceiver, and DtFixedWingLandingController.

virtual DtOutputStream& DtSimComponent::objectConsoleDebug ( ) const

virtual

Returns: The stream that is routed to the owning object's console.

virtual DtOutputStream& DtSimComponent::objectConsoleVerbose ( ) const

virtual

Returns: The stream that is routed to the owning object's console.

virtual DtOutputStream& DtSimComponent::objectConsoleInfo ( ) const

virtual

Returns: The stream that is routed to the owning object's console.

virtual DtOutputStream& DtSimComponent::objectConsoleWarn ( ) const

virtual

Returns: The stream that is routed to the owning object's console.

virtual DtOutputStream& DtSimComponent::objectConsoleError ( ) const

virtual

Returns: The stream that is routed to the owning object's console.

DtVrfProcessStateRepositoryManager* DtSimComponent::psrManager ( )

Returns: The PSR manager that should be used by this component. This will be the PSR manager that is owned by the component's parent system. Non-virtual so that it can be used by the destructor.

virtual DtSimResourceManager& DtSimComponent::resourceManager ( )

virtual

Returns: A pointer to the resource manager of the system that this component is part of.

virtual const DtSimResourceManager& DtSimComponent::resourceManager ( ) const

virtual

Returns: A pointer to the resource manager of the system that this component is part of.

virtual DtString DtSimComponent::componentFullName ( ) const

virtual

Returns: A string that uniquely names this component on the entity. The name will be composed of the systems containing this component, and the reader-writer name of this component.

static DtSimComponentFactory* DtSimComponent::factory ( )

static

A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set.

The DtSimCreator deletes this pointer when it is deleted. This is done this way because we don't allow static initialization.

Reimplemented from DtReaderWriter.

static void DtSimComponent::setFactory ( DtSimComponentFactory * factory )

static

static DtSimComponent* DtSimComponent::createComponent	(	const DtString &	name,
		const DtString &	type,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentSystem *	parentSystem,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

Creates a DtSimComponent using the factory, then initializes it via the MTL stream.

static void DtSimComponent::addSimComponentCreatorFcn	(	const DtString &	type,
		DtSimComponentCreatorFcn	fcn
	)

static

Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key.

The type string is one of the types defined in compTypes.h.

Parameters

type	Type identifying particular derived type of DtSimComponent
fcn	Creation function that instantiates a new DtSimComponent.

bool DtSimComponent::testInvariant ( ) const

protected

Returns: A boolean indicating whether or not the class invariant remains valid or not. Should always be true at the beginning of every public member function, and also at the end of all non-const public member functions.

virtual bool DtSimComponent::createPortGroups ( )

protectedvirtual

Called by init.

Derived classes should override this method to create all their input/output port groups.

Reimplemented in DtAutomotiveActuatorComponent, DtFixedWingPilotController, DtFixedWingActuatorComponent, DtHumanCollisionAvoidanceController, DtGroundMoveToDestinationControllerComponent, DtGroundCollisionAvoidanceController, DtHumanFollowController, DtBallisticGun, DtObstructionSensor, DtIndirectFireController, DtHumanMovementActuator, DtGroundAutoControllerComponent, DtSurfaceEntityActuator, DtSurfaceEntityPilotController, DtAggregatedMoveToController, DtBaseWeaponController, DtHumanMoveToController, DtBaseMountingController, BHAVE::DtKynapseController, DtBallisticGunController, DtMissileControllerComponent, DtWeaponActuator, DtHumanMoveAlongController, DtObjectSensor, DtRotaryWingPilotController, DtAggregatedMoveAlongController, BHAVE::DtKynapseGroundPlatformController, DtRotaryWingActuatorComponent, DtRotaryWingTaskController, BHAVE::DtKynapseLifeformController, DtMountingElevationActuator, DtMountingAzimuthActuator, DtMissileManeuverActComponent, DtAggregatedMovementActuator, DtGroundMoveDirectionController, DtAirVehicleWeaponHoldController, DtHumanEyepointController, DtDefaultLandingGearController, DtHumanTurnToController, DtHumanStopMovingController, DtHumanAimWeaponController, and DtHumanJoystickMovementController.

virtual bool DtSimComponent::createPorts ( )

protectedvirtual

Called by init.

Derived classes should override this method to create all their input/output ports and port groups.

Reimplemented in DtAutomotiveActuatorComponent, DtFixedWingPilotController, DtFixedWingActuatorComponent, DtWeaponController, DtHumanCollisionAvoidanceController, DtGroundMoveToDestinationControllerComponent, DtGroundCollisionAvoidanceController, DtHumanFollowController, DtBallisticGun, DtObstructionSensor, DtSurfaceEntityActuator, DtSurfaceEntityPilotController, DtHumanMovementActuator, DtGroundAutoControllerComponent, DtAggregatedMoveToController, DtSimpleRotaryWingPilot, DtDIGuyController, DtBaseWeaponController, DtLauncherController, DtHumanMoveToController, DtTargetSelectionController, DtIndirectFireActuator, DtBaseMountingController, BHAVE::DtKynapseController, DtGroundInterceptAndDestroyController, DtMissileControllerComponent, DtWeaponActuator, DtDetonationController, DtBallisticGunController, DtGroundFollowEntityController, DtHumanMoveAlongController, DtSpotReportGeneratorController, DtObjectSensor, DtRotaryWingPilotController, DtHumanAcquireController, DtAggregatedMoveAlongController, DtFixedWingLandingController, DtTurretAcquireController, DtTurretSlewController, BHAVE::DtBhaveMovementChooserController, BHAVE::DtKynapseGroundPlatformController, DtTurretActuatorComponent, DtRotaryWingActuatorComponent, DtWarheadDetonationActuator, DtLaserGuidedLauncherController, DtRotaryWingTaskController, DtBallisticGunJoyController, DtLauncherActuator, BHAVE::DtBhaveMoveDirectionController, BHAVE::DtKynapseLifeformController, DtMountingElevationActuator, DtMountingAzimuthActuator, DtMissileManeuverActComponent, DtBombController, DtContactFusionController, DtSpotReportReceiver, DtAirVehicleWeaponHoldController, DtHumanPostureController, DtLaserDetector, DtAggregatedMovementActuator, DtHumanEyepointController, DtSwingingPartActuator, DtGroundMoveDirectionController, DtIndirectFireWeaponController, DtIntegratedLaserGuidedLauncherController, DtSimpleRadarWarningReceiver, DtBombActuator, DtDefaultLandingGearController, DtHumanWeaponStateActuator, DtHumanAimWeaponController, DtSimpleRadarWarningResponse, and DtBallisticGunJoy.

virtual DtPhysicalWorld* DtSimComponent::physicalWorld ( )

protectedvirtual

Gets the physical world that this component's entity exists in.

virtual const DtPhysicalWorld* DtSimComponent::physicalWorld ( ) const

protectedvirtual

virtual DtAttachedTerrain* DtSimComponent::terrainAttachedTo ( )

protectedvirtual

Gets the terrain that this component's entity is attached to, if any.

virtual const DtAttachedTerrain* DtSimComponent::terrainAttachedTo ( ) const

protectedvirtual

virtual DtVrfObject* DtSimComponent::entity ( )

protectedvirtual

Gets the entity.

virtual const DtVrfObject* DtSimComponent::entity ( ) const

protectedvirtual

virtual DtSimManager* DtSimComponent::simManager ( )

protectedvirtual

Gets the sim manager.

virtual const DtSimManager* DtSimComponent::simManager ( ) const

protectedvirtual

virtual const Coordinate_System* DtSimComponent::coordinateSystem ( ) const

protectedvirtual

Gets the coordinate system, as it should always exist if the physical world is in a valid state!

Note: If this function is called while the physical world is in an invalid state, the results are undefined.

virtual Coordinate_System* DtSimComponent::coordinateSystem ( )

protectedvirtual

virtual DtVrfObjectStateRepository* DtSimComponent::localStateRepository ( )

protectedvirtual

Gets the local state repository.

virtual const DtVrfObjectStateRepository* DtSimComponent::localStateRepository ( ) const

protectedvirtual

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

private

assignment operator, not implemented

Member Data Documentation

DtVrfObject* DtSimComponent::myEntity

protected

DtVrfObjectStateRepository* DtSimComponent::myLocalStateRepository

protected

DtSimManager* DtSimComponent::mySimManager

protected

DtComponentSystem* DtSimComponent::mySystem

protected

Pointer to the DtComponentSystem that this component belongs.

DtListItem* DtSimComponent::myListItem

protected

DtInputPortMap DtSimComponent::myInputPortList

protected

DtOutputPortMap DtSimComponent::myOutputPortList

protected

DtInputPortGroupMap DtSimComponent::myInputPortGroupList

protected

DtOutputPortGroupMap DtSimComponent::myOutputPortGroupList

protected

DtSimComponentFactory* DtSimComponent::myFactory

staticprotected

int DtSimComponent::myPriority

protected

double DtSimComponent::myMinTickPeriod

protected

double DtSimComponent::myMinTickPeriodVariance

protected

double DtSimComponent::myNextTickTime

protected

double DtSimComponent::myLastTickSimTime

protected

double DtSimComponent::myDT

protected

Referenced by dT().

bool DtSimComponent::myIsEnabled

protected

Indicates whether this component should be enabled for ticking or not.

bool DtSimComponent::myFirstTick

protected

Initialized to true in the constructor, set to false by the first call to postTick.

const DtComponentDescriptor* DtSimComponent::myComponentDescriptor

protected

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

include/vrfobjcore/simCmpnt.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation