VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
DtLasingController Class Reference

Class Description: DtLasingController Lases a target location or entity. More...

Inheritance diagram for DtLasingController:
Inheritance graph
[legend]

Classes

class  DtLasingControllerInput
 Base class for lasing controller target inputs. More...
class  DtLasingControllerPortInput
 Derived input that uses a port. More...
class  DtLasingControllerWeaponInterfaceInput
 Derived input that uses a DtWeaponComponentInterface. More...

Public Member Functions

 DtLasingController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 constructor
virtual ~DtLasingController ()
 destructor
virtual bool init ()
 Calls setRadio()
virtual DtString type () const
 This returns a string from compTypes.h, and identifies the type of component.
virtual void preFirstTickInit ()
 If the designator code from the PSR is < 0, sets the code in the PSR to defaultLaserCode() and otherwise sets to to the current code from the descriptor.
virtual void tick ()
 Determines whether or not the laser should be on or off.
virtual void setDesignatorCode (const int code)
 Set or query the controllers laser code.
virtual const int designatorCode () const
virtual void clearTask ()
 If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.
virtual bool createProcessSR ()
 This function gets the name of the process state repository being shared by all components in the lasing system and then gets a pointer to it via the entity's processStateRepositoryManager.
virtual void startLasing ()
 Turn Lasing on or off.
virtual void stopLasing ()
virtual void laseTarget (DtVrfObject *targetObject)
 Updates the laser state for the target.
virtual bool lasing ()
 Determine if the laser is on or off.
virtual void registerTaskMsgCallbacks ()
 Registers its interest in set target request messages.
virtual void registerSetLaseAutonomousMsgCallbacks ()
virtual void registerSetLaserCodeRequestMsgCallbacks ()
virtual void processLaseTargetTaskMessage (DtSimMessage *msg)
virtual void processSetLaseAutonomousRequestMessage (DtSimMessage *msg)
virtual void processSetLaserCodeRequestMessage (DtSimMessage *msg)
virtual void processRequestLaserCode (const DtVrfObjectMessage *msg)
- Public Member Functions inherited from DtSingleTaskControllerComponent
 DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtSingleTaskControllerComponent ()
 destructor
virtual void postTick ()
 Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
 Called by the task manager when this controller should start executing the specified task.
virtual void taskNotify (const DtSimTask &task)
 This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void taskComplete (bool success=true)
 If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
virtual void suspendTask ()
 This method is called when the currently running task is being suspended.
virtual int sendSubtask (DtSimTask &task)
 Sends subtask to ourself.
virtual void clearSubtask (int subtaskId)
 Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void addPendingSubtaskId (int subtaskId)
 Adds given subtask Id to list of pending subtasks.
virtual bool findPendingSubtaskId (int subtaskId)
 Checks to see if given subtaskId exists in our list of pending subtasks.
virtual void removePendingSubtaskId (int subtaskId)
 Removes pending subtask from list of subtasks for this component.
virtual void removeAllPendingSubtaskIds ()
 Clear all pending subtasks from our list of subtasks.
virtual std::vector< intcurrentPendingSubstaskIds () const
 Returns the list of all currently pending subtask ids for this controller.
virtual void clearCurrentTaskMessage ()
 Returns the current subtask with the specified id.
virtual DtTaskMessagecurrentTaskMessage () const
 Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr currentTaskState () const
virtual bool decideToGiveUpTask () const
 This function is used to determine if the controller should give up trying to execute the current task.
virtual void giveUpTask ()
 Called when controller is tasked and decideToGiveUp() returns true.
virtual bool taskActive (int taskId) const
 
virtual bool clearTopLevelTasks ()
 If this controller has any top level tasks (not subtasks), they are cleared.
virtual void clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
 Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void clearTasksByType (const DtSimTaskMessageType &taskType)
 Clears any tasks of the specified type running in this controller.
virtual void clearTaskById (int taskId)
 Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfosuspendTaskById (int taskId)
virtual std::list
< DtTaskMessage * > 
currentTaskMessages () const
 
virtual DtTaskWithTaskStateListPtr topLevelTasks () const
 
- Public Member Functions inherited from DtTaskControllerComponent
 DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtTaskControllerComponent ()
 destructor
virtual bool showCurrentTaskInGui () const
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Adds a new function for processing the specified task type.
virtual void addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Deprecated form of addTaskProcessorCallback.
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
 Undoes anything done by addTaskProcessorCallback().
virtual void removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
 Deprecated form of removeTaskProcessorCallback.
virtual void enable ()
 Overridden to call registerTaskMsgCallbacks().
virtual void disable ()
 Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void sendTaskCanceled (DtTaskMessage *taskMsg)
 Sends the task canceled report for the specified message.
virtual void setTasked (bool tasked)
 The current tasked state of this controller.
virtual bool tasked () const
 The current tasked state of this controller.
- 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 DtSimRadioradio ()
 The radio this component is listening to.
- 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 registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preprocess ()
 Perform parallel preprocessing prior to tick and similar computations.
virtual void parallelTick ()
 called in parallel
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 DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
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 DtReaderWriter::SearchPaths &searchPaths, 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 DtInputPortlookupInputPort (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 DtOutputPortlookupOutputPort (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 DtInputPortGrouplookupInputPortGroup (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 DtOutputPortGrouplookupOutputPortGroup (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.
DtVrfProcessStateRepositoryManagerpsrManager ()
virtual DtString componentFullName () const
virtual DtPhysicalWorldphysicalWorld ()
 Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorldphysicalWorld () const
virtual DtAttachedTerrainterrainAttachedTo ()
 Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrainterrainAttachedTo () const
virtual DtVrfObjectentity ()
 Gets the entity.
virtual const DtVrfObjectentity () const
virtual DtSimManagersimManager ()
 Gets the sim manager.
virtual const DtSimManagersimManager () 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
virtual bool isEnabled ()
 Is this component enabled or not.
virtual void setIsEnabled (bool yesNo)
 Is this component enabled or not.
virtual DtOutputStreamobjectConsoleDebug () const
virtual DtOutputStreamobjectConsoleVerbose () const
virtual DtOutputStreamobjectConsoleInfo () const
virtual DtOutputStreamobjectConsoleWarn () const
virtual DtOutputStreamobjectConsoleError () const
virtual DtSimResourceManagerresourceManager ()
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)
 pseudo-copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void postPutSelf ()
 Called after either version of put self (file or environment). Default is no-op.
virtual void prePutSelf ()
 Called before either version of put self (file or environment). Default is no-op.
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void postGetSelf ()
 Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void preGetSelf ()
 Called before either version of get self (file or environment). Default is no-op.
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 aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int alignment () const
 For those items that are sent over the network via HLA, this will give the network alignment.
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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () const
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
std::string debugText () const
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 bool hasVariableReference () const
 Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void recordUpdateTime () const
 Can be implemented in subclasses to stamp the time when updated.
virtual bool wasUpdatedSince (DtTime t) const
 Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void setDefaultRWValue (DtReaderWriter *)
 Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () const
virtual DtString toXml () const
virtual bool toXml (const DtFilename &) const
 Writes contents of xml result to the given filename.
virtual bool fromXml (const DtString &)
 Restores object from given xml string. Returns true if valid.
virtual bool fromXmlFile (const DtFilename &)
 Restires object from given xml file.
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 Override to add attributes of actual data.
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 Called when the item is a variable reference.
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())
 Gets data from the environment value.
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 Called when the item is a variable reference.

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
static void laseTargetTaskCallback (DtSimMessage *msg, void *usrData)
static void setLaseAutonomousRequestCallback (DtSimMessage *msg, void *usrData)
static void setLaserCodeRequestCallback (DtSimMessage *msg, void *usrData)
static void requestLaserCodeCallback (const DtVrfObjectMessage *msg, void *usr)

Protected Member Functions

 DtLasingController ()
 Default constructor; should not be called.
 DtLasingController (const DtLasingController &orig)
 copy constructor; shallow; does not copy the ports.
const DtLasingControlleroperator= (const DtLasingController &orig)
 assignment operator; see comments on copy constructor!
virtual bool lineOfSight (DtVrfObject *target, DtString &reason)
 Determines whether or not the controller has line of sight with the target.
virtual void tickLaser ()
virtual void setRadio (DtSimRadio *radio)
 Override this so we can register interest in setTargetMessages messages.
virtual bool createPublisher ()
virtual bool createTargetInput ()
virtual double laserPower () const
virtual double laserWavelength () const
virtual bool laseTargetValid (DtVrfObject *target, DtString &invalidReason)
virtual DtVrfObjectchooseAutonomousLaseTarget ()
virtual int defaultLaserCode () const
virtual void processObjectAboutToBeRemovedCallback (DtVrfObject *vrfObject)
 Called by objectAboutToBeRemovedCallback, calls stopLasing if the object being removed is the same as the current target object.
- Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void clearPendingSubtasks ()
 Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void clearSubtasksByType (const DtSimTaskMessageType &taskType)
 Clear all subtasks of a given type.
- Protected Member Functions inherited from DtTaskControllerComponent
virtual void suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
 Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT, common between preprocess and timedTick.
bool testInvariant () const
virtual bool createPortGroups ()
 Called by init.
virtual bool createPorts ()
 Called by init.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()
- Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
 DtObjectDebugger ()
 DtObjectDebugger (const DtObjectDebugger &)
 ~DtObjectDebugger ()

Static Protected Member Functions

static void objectAboutToBeRemovedCallback (DtVrfObject *vrfObject, void *usr)
 Registered on the objectManager by startLasing() in order to detect when a target object is being removed.

Protected Attributes

DtVrfObjectmyCurrentLasedTarget
DtLasingPSRmyProcessState
 Current target we're lasing–point or entity.
const
DtLasingControllerDescriptor
myComponentDescriptor
DtDesignatorPublisher * myDesPublisher
DtLasingControllerInputmyLasingInput
 Depending on whether this DtLasingController is integrated with a weapon system or not, it can have either a port input or a weapon interface input.
bool myInvalidTargetMsgPrinted
 Remember if an invalid-target message has been printed (print it once)

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 )()
- Protected Types inherited from DtTaskControllerComponent
typedef std::pair
< DtTaskMessageCallbackFcn,
void * > 
DtTaskCallbackMapPair
 This map stores callbacks that have been registered to processes various tasks.
typedef std::map
< DtSimTaskMessageType,
DtTaskCallbackMapPair
DtTaskCallbackMap
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Detailed Description

Class Description: DtLasingController Lases a target location or entity.

Determines the visibility of the target and publishes the designator information on the network Uses Descriptor Type: DtLasingControllerDescriptor

Constructor & Destructor Documentation

DtLasingController::DtLasingController ( )
protected

Default constructor; should not be called.

DtLasingController::DtLasingController ( const DtLasingController orig)
protected

copy constructor; shallow; does not copy the ports.

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

constructor

virtual DtLasingController::~DtLasingController ( )
virtual

destructor

Member Function Documentation

const DtLasingController& DtLasingController::operator= ( const DtLasingController orig)
protected

assignment operator; see comments on copy constructor!

virtual bool DtLasingController::init ( )
virtual

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual DtString DtLasingController::type ( ) const
virtual

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

Implements DtTaskControllerComponent.

virtual void DtLasingController::preFirstTickInit ( )
virtual

If the designator code from the PSR is < 0, sets the code in the PSR to defaultLaserCode() and otherwise sets to to the current code from the descriptor.

Calls setAutonomous on the PSR with the setting from the descriptor.

Reimplemented from DtSimComponent.

virtual void DtLasingController::tick ( )
virtual

Determines whether or not the laser should be on or off.

If the laser is on, it checks if it should be turned off because the target is missing or destroyed. If the laser is off, it checks if it is capable of lasing,with autonomous set to true, and if it has a target from the sensor port. The final thing the laser checks if it determines it should lase its target is if the target is in range and it has line of sight. Publishes the designator state on the network

Reimplemented from DtSimComponent.

virtual void DtLasingController::setDesignatorCode ( const int  code)
virtual

Set or query the controllers laser code.

virtual const int DtLasingController::designatorCode ( ) const
virtual
virtual void DtLasingController::clearTask ( )
virtual

If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.

Reimplemented from DtSingleTaskControllerComponent.

virtual bool DtLasingController::createProcessSR ( )
virtual

This function gets the name of the process state repository being shared by all components in the lasing system and then gets a pointer to it via the entity's processStateRepositoryManager.

virtual void DtLasingController::startLasing ( )
virtual

Turn Lasing on or off.

virtual void DtLasingController::stopLasing ( )
virtual
virtual void DtLasingController::laseTarget ( DtVrfObject targetObject)
virtual

Updates the laser state for the target.

Calls startLasing() if not already lasing.

virtual bool DtLasingController::lasing ( )
virtual

Determine if the laser is on or off.

static DtSimComponent* DtLasingController::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static
virtual void DtLasingController::registerTaskMsgCallbacks ( )
virtual

Registers its interest in set target request messages.

Reimplemented from DtTaskControllerComponent.

virtual void DtLasingController::registerSetLaseAutonomousMsgCallbacks ( )
virtual
virtual void DtLasingController::registerSetLaserCodeRequestMsgCallbacks ( )
virtual
static void DtLasingController::laseTargetTaskCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtLasingController::setLaseAutonomousRequestCallback ( DtSimMessage msg,
void *  usrData 
)
static
static void DtLasingController::setLaserCodeRequestCallback ( DtSimMessage msg,
void *  usrData 
)
static
virtual void DtLasingController::processLaseTargetTaskMessage ( DtSimMessage msg)
virtual
virtual void DtLasingController::processSetLaseAutonomousRequestMessage ( DtSimMessage msg)
virtual
virtual void DtLasingController::processSetLaserCodeRequestMessage ( DtSimMessage msg)
virtual
static void DtLasingController::requestLaserCodeCallback ( const DtVrfObjectMessage msg,
void *  usr 
)
static
virtual void DtLasingController::processRequestLaserCode ( const DtVrfObjectMessage msg)
virtual
virtual bool DtLasingController::lineOfSight ( DtVrfObject target,
DtString reason 
)
protectedvirtual

Determines whether or not the controller has line of sight with the target.

virtual void DtLasingController::tickLaser ( )
protectedvirtual
virtual void DtLasingController::setRadio ( DtSimRadio radio)
protectedvirtual

Override this so we can register interest in setTargetMessages messages.

Reimplemented from DtTaskControllerComponent.

virtual bool DtLasingController::createPublisher ( )
protectedvirtual
virtual bool DtLasingController::createTargetInput ( )
protectedvirtual
virtual double DtLasingController::laserPower ( ) const
protectedvirtual
Returns
The power specified in the component descriptor. Override this method if you want to publish the laser with a different power.
virtual double DtLasingController::laserWavelength ( ) const
protectedvirtual
Returns
The wavelength specified in the component descriptor. Override this method if you want to publish the laser with a different wavelength.
virtual bool DtLasingController::laseTargetValid ( DtVrfObject target,
DtString invalidReason 
)
protectedvirtual
Returns
True if the specified target entity is a valid lase target for this controller.
Parameters
invalidReasonThis string will be filled in with a text reason for the target being invalid, if the return value is false.
virtual DtVrfObject* DtLasingController::chooseAutonomousLaseTarget ( )
protectedvirtual
Returns
A valid lase target for the "lase autonomous" mode, or NULL if there is not valid target available.
virtual int DtLasingController::defaultLaserCode ( ) const
protectedvirtual
Returns
The default laser code. Calls generateLaserCodeFromName().
static void DtLasingController::objectAboutToBeRemovedCallback ( DtVrfObject vrfObject,
void *  usr 
)
staticprotected

Registered on the objectManager by startLasing() in order to detect when a target object is being removed.

virtual void DtLasingController::processObjectAboutToBeRemovedCallback ( DtVrfObject vrfObject)
protectedvirtual

Called by objectAboutToBeRemovedCallback, calls stopLasing if the object being removed is the same as the current target object.

Member Data Documentation

DtVrfObject* DtLasingController::myCurrentLasedTarget
protected
DtLasingPSR* DtLasingController::myProcessState
protected

Current target we're lasing–point or entity.

Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).

const DtLasingControllerDescriptor* DtLasingController::myComponentDescriptor
protected
DtDesignatorPublisher* DtLasingController::myDesPublisher
protected
DtLasingControllerInput* DtLasingController::myLasingInput
protected

Depending on whether this DtLasingController is integrated with a weapon system or not, it can have either a port input or a weapon interface input.

myLasingInput holds this input object.

bool DtLasingController::myInvalidTargetMsgPrinted
protected

Remember if an invalid-target message has been printed (print it once)


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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)