End User Description: DtControllerComponent is the base class for all controllers components.
Developer Description: The DtControllerComponent class extends the base DtSimComponent to perform some task management upon the start of a task, and in the event that a task is being cleared. It caches a pointer to the entity's radio for convenience. The DtControllerComponent class implements the functionality of the DtScriptEnableController.

Inherits DtSimComponent.

Inherited by DtActivityController, DtAggregateCombatAdjustmentController, DtAggregateDatabaseLoggingController, DtAggregateLoadoutController, DtAimAtPointController, DtAimWeaponController, DtAircraftAdsbController, DtAirVehicleWeaponHoldController, DtArticulatedPartController, DtBaseMountingController, DtBreachDetector, DtCombatRangeController, DtContactFusionController, DtDefaultLandingGearController, DtDisaggregatedFormationController, DtDynamicFeaturesController, DtEngagementReportGeneratorController, DtEnvironmentalActivationController, DtEventTriggerController, DtFixedWingGunneryController, DtGpsJammerController, DtGpsReceiverController, DtGroundVehicleTrailingEffectController, DtHumanAcquireController, DtHumanEyepointController, DtHumanFaceTargetController, DtHumanPostureController, DtIffControllerComponent, DtJammerController, DtMissileDistractionController, DtMovementBasedTerrainPreloadController, DtNavTagTraversalController, DtOrganizationController, DtRangeRingController, DtRotaryWingLandingGearController, DtRotaryWingPilotController, DtRotorWashController, DtScriptEnableController, DtScriptReactiveTaskController, DtSetController, DtShapeBasedTerrainPreloadController, DtShipAisController, DtSpawnController, DtSpotReportGeneratorController, DtStatePropertyInitializationController, DtSyncMatrixController, DtSystemSwitcherComponent, DtTagVolumeDimensionsController, DtTaskControllerComponent, DtTDLMessageGeneratorController, DtTurretAcquireController, DtTurretSlewController, and DtVrfObjectDataMessenger.

Public Member Functions
	DtControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent () override

virtual const char *	type () const override=0

virtual bool	init () override

virtual bool	postAddComponentsInit () override

virtual DtSimRadio *	radio ()

virtual void	taskNotify (const DtSimTask &task)

virtual void	clearTask ()

virtual void	enableTaskTypes ()

virtual void	enableScriptedTask (const DtString &scriptId)

virtual void	disableTaskTypes ()

virtual void	enable () override

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent () override

virtual void	setParentSystem (DtComponentSystem *system)

DtComponentSystem *	parentSystem () const

virtual void	registerAttributeFunctions ()

virtual void	preFirstTickInit ()

virtual void	tick ()

virtual void	postTick ()

virtual void	timedTick ()

virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)

virtual void	setupFirstTickTime ()

virtual void	setEntity (DtLocalObject *entity)

virtual DtSimComponent *	nextComponent ()

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)

virtual DtListItem *	listItem ()

virtual void	putData (std::string &fp, int indentLevel=0) override

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override

virtual void	addInputPort (DtInputPort *port)

virtual void	removeInputPort (DtInputPort *port)

virtual DtInputPort *	lookupInputPort (const DtString &portName)

virtual DtList	inputPortList () const

virtual void	addOutputPort (DtOutputPort *port)

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)

virtual DtList	outputPortList () const

virtual void	addInputPortGroup (DtInputPortGroup *group)

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)

virtual DtList	inputPortGroupList () const

virtual void	addOutputPortGroup (DtOutputPortGroup *group)

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)

virtual DtList	outputPortGroupList () const

virtual int	priority () const

virtual void	setPriority (int priority)

double	dT () const

virtual void	setDT (double deltaT)

virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)

virtual const DtComponentDescriptor *	componentDescriptor () const

virtual bool	tickWhileDestroyed () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()

const DtPhysicalWorld *	physicalWorld () const

const DtAttachedTerrain *	terrainAttachedTo () const

DtLocalObject *	entity ()

const DtLocalObject *	entity () const

DtSimulationServices *	simulationServices ()

const DtSimulationServices *	simulationServices () const

const Coordinate_System *	coordinateSystem () const

virtual void	isClutterChanged ()

virtual bool	taskVisualizationsActive () const

virtual bool	taskVisualizationsEnabled () const

makVrf::DtTaskVisualizationMap &	taskVisualizations ()

virtual void	updateImgui ()

virtual bool	debugActive () const

virtual void	disable ()

virtual bool	isEnabled ()

virtual void	setIsEnabled (bool yesNo)

virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const

virtual int	notifyLevel () const

virtual DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

VRF4API_METHOD const DtSimulationServices *	simManager () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
	DtControllerComponent ()

	DtControllerComponent (const DtControllerComponent &orig)

const DtControllerComponent &	operator= (const DtControllerComponent &orig)

virtual void	onRestore () override

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

virtual void	setRadio (DtSimRadio *radio)

virtual void	sendCapableSetsAndTasks ()

Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)

virtual double	computeCurrentTime ()

bool	testInvariant () const

virtual bool	createPortGroups ()

virtual bool	createPorts ()

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)

virtual void	updateTaskVisualizations ()

virtual void	destroyTaskVisualizations ()

virtual void	destroyTaskVisualization (const DtString &name)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)

double	calculateNextTaskVisTickTime () const

DtVrfObjectStateRepository *	localStateRepository ()

const DtVrfObjectStateRepository *	localStateRepository () const

DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)

template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)

const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const

template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) const

void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)

void	removeSimObjectPredicateCallback (const DtSimObject , DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void userData=0)

void	invokeSimObjectPredicateCallbacks ()

virtual void	clearPredicateCallbacks ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtSimRadio *	myRadio

parameters
These parameters are used to implement the functionality of the DtScriptEnableController.
bool	myTaskTypesEnabled

bool	myInitialized

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myLastTickSimTime

std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager *	myPredicateCallbackManager

boost::signals2::scoped_connection	myIsClutterChangedConnection

bool	myLocalDebug

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

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::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject owner, DtSimulationServices simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)

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

static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

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

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtControllerComponent::DtControllerComponent	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simServices,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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 DtControllerComponent::~DtControllerComponent ( )

overridevirtual

destructor

DtControllerComponent::DtControllerComponent ( )

protected

default constructor

DtControllerComponent::DtControllerComponent ( const DtControllerComponent & orig )

protected

copy constructor

Member Function Documentation

virtual const char* DtControllerComponent::type ( ) const

overridepure virtual

This returns a string from compTypes.h, and identifies the type of component.

Implements DtSimComponent.

virtual bool DtControllerComponent::init ( )

overridevirtual

Calls setRadio()

Reimplemented from DtSimComponent.

virtual bool DtControllerComponent::postAddComponentsInit ( )

overridevirtual

Calls enableTaskTypes()

Reimplemented from DtSimComponent.

Reimplemented in DtFixedWingPilotController, DtGroundAutoControllerComponent, DtSimpleRotaryWingPilot, DtSurfaceEntityPilotController, DtSurfaceEntityFollowEntityController, DtGroundManeuverInFormationControllerComponent, DtMissileControllerComponent, DtRotaryWingTaskController, DtHumanAcquireController, DtSubSurfaceDepthController, DtBombController, DtFixedWingDefaultController, DtGroundMoveToAdapterComponent, DtTurretAcquireController, DtBallisticGunController, DtLaunchExpendableResourceController, DtSensorGimbalController, DtFixedWingTakeoffController, DtNavigationPreferenceController, DtFixedWingLandingController, DtBaseWeaponController, DtDetonationController, DtResupplyController, DtFixedWingGunneryController, DtAggregateMountedMovementRelayController, DtResupplySupplierController, DtAggregatedSetController, DtBaseMountingController, DtResupplyReceiverController, DtAircraftClutterAreaController, DtShipClutterAreaController, DtAimWeaponController, DtEventTriggerController, DtAggregateLoadoutController, DtMoppEnableController, DtWeaponManagementController, DtShipAisController, and DtAircraftAdsbController.

virtual DtSimRadio* DtControllerComponent::radio ( )

virtual

The radio this component is listening to.

virtual void DtControllerComponent::taskNotify ( const DtSimTask & task )

virtual

This is used by the entity to notify all controllers that a new task has been received. It will NOT be called for the controller that received the task; it is used to inform the others...

Reimplemented in DtTaskControllerComponent, and DtSingleTaskControllerComponent.

virtual void DtControllerComponent::clearTask ( )

virtual

Called when you want to clear out this component's task state. Base class implementation does nothing.

virtual void DtControllerComponent::enableTaskTypes ( )

virtual

Finds the script controller, and enables the new task types on that controller. Calls enableScriptedTask for each scripted task Id listed in descriptor.

Reimplemented in DtWeaponManagementController.

virtual void DtControllerComponent::enableScriptedTask ( const DtString & scriptId )

virtual

For scripted tasks, background processes, or sets will add to the scripted task controller. For scripted reactive tasks, will add to the scripted reactive task controller–Additionally checks if the reactive task should be enabled by default or not.

virtual void DtControllerComponent::disableTaskTypes ( )

virtual

Finds the script controller, and disables the task types on that controller.

virtual void DtControllerComponent::enable ( )

overridevirtual

Enables the component and resends capable tasks and sets.

Reimplemented from DtSimComponent.

Reimplemented in DtEmbarkationController, DtIndirectFireWeaponController, DtWeaponController, DtTaskControllerComponent, DtIffControllerComponent, DtBallisticGunController, DtDisaggregatedFormationController, DtJammerController, DtMovementBasedTerrainPreloadController, DtWaitController, DtProvideIndirectFireController, DtAggregatedSetController, DtSystemSwitcherComponent, DtHoldController, and DtSetController.

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

protected

assignment operator

virtual void DtControllerComponent::onRestore ( )

overrideprotectedvirtual

Override to iterate over the descriptor to see if there are any targeting control tables. If there are then restore the resources from them into the resource manager.

Reimplemented from DtSimComponent.

Reimplemented in DtGroundManeuverInFormationControllerComponent.

virtual void DtControllerComponent::initializeTargetingControlTableFromDescriptor ( const DtReaderWriter * )

protectedvirtual

virtual void DtControllerComponent::setRadio ( DtSimRadio * radio )

protectedvirtual

Reimplemented in DtAggregatedSetController, DtLasingController, DtIffControllerComponent, DtTaskControllerComponent, DtDisaggregatedFormationController, DtOrganizationController, DtSystemSwitcherComponent, DtAggregateOrganizationController, vrfAddSetExample::MyHumanSetController, vrfAddSetExample::MyAirVehicleSetController, vrfAddSetExample::MyFixedWingEntitySetController, vrfAddSetExample::MyGroundVehicleSetController, vrfAddSetExample::MyLocalEntitySetController, DtSetController, and DtActivityController.

virtual void DtControllerComponent::sendCapableSetsAndTasks ( )

protectedvirtual

Sends an updated capable sets and task message.

Member Data Documentation

DtSimRadio* DtControllerComponent::myRadio

protected

Controller components can send messages. Of course, if your controller never will, you don't have to use this.

bool DtControllerComponent::myTaskTypesEnabled

protected

Whether task types are currently enabled.

bool DtControllerComponent::myInitialized

protected

Whether task types are currently enabled.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjcore/controllerComponent.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation