VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
DtTDLContactMessageGeneratorController Class Reference
Inheritance diagram for DtTDLContactMessageGeneratorController:
Inheritance graph
[legend]

Public Member Functions

 DtTDLContactMessageGeneratorController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtTDLContactMessageGeneratorController ()
 Destructor.
virtual const chartype () const
 Returns a string identifies the class type of component.
- Public Member Functions inherited from DtVrfTDLMessageGeneratorController
 DtVrfTDLMessageGeneratorController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtVrfTDLMessageGeneratorController ()
 Destructor.
- Public Member Functions inherited from DtTDLMessageGeneratorController
 DtTDLMessageGeneratorController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtTDLMessageGeneratorController ()
 Destructor.
virtual bool init ()
 Init.
virtual void tick ()
 This components simulation tick.
- 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.
virtual void taskNotify (const DtSimTask &task)
 This is used by the entity to notify all controllers that a new task has been received.
virtual void clearTask ()
 Called when you want to clear out this component's task state.
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual ~DtSimComponent ()
 destructor
void setParentSystem (DtComponentSystem *system)
 Sets the parent system of this component.
virtual bool postAddComponentsInit ()
 Called after all components have been created, initialized and added to the component manager.
virtual void registerAttributeFunctions ()
 Called to register functions that provide system attribute values.
virtual void preFirstTickInit ()
 This function can be overridden to initialize a component before it is ticked for the first time.
virtual void postTick ()
 This function is called immediately after tick() is called.
virtual void timedTick ()
 This version of tick checks to see if the time to tick has arrived.
virtual void setMinTickPeriod (double minTickPeriod)
 specifies a minimum tick period (which can also be thought of as
virtual double minTickPeriod () const
 access the minimum tick period
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 set the variance in the minimum tick time
virtual double minTickPeriodVariance () const
 access the variance in the minimum tick period
virtual void setNextTickTime (double nextTickTime)
 The next tick time is normally calculated internally.
virtual double nextTickTime () const
 access the next tick time
virtual double calculateNextTickTime () const
 The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double calculateFirstTickTime () const
 Returns the first time value that the component should tick at.
virtual void setEntity (DtVrfObject *entity)
 The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponentnextComponent ()
 List management functions.
virtual DtSimComponentprevComponent ()
virtual void setListItem (DtListItem *item)
 Used by DtComponentList.
virtual DtListItem * listItem ()
virtual void putData (std::string &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_SystemcoordinateSystem () const
 Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_SystemcoordinateSystem ()
virtual
DtVrfObjectStateRepository
localStateRepository ()
 Gets the local state repository.
virtual const
DtVrfObjectStateRepository
localStateRepository () const
virtual DtTaskVisualizationMaptaskVisualizations ()
 Returns the list of task visualizations for this component.
virtual bool taskVisualizationsActive () const
 Returns true if task visualizations are currently active for this component.
virtual bool taskVisualizationsEnabled () const
 Returns true if task visualizations are enabled for this component.
virtual void enable ()
 Is this component enabled or not.
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 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 (std::string &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 (std::string &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 void addAlias (const DtString &alias)
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
bool isReadonly () const
virtual void reset ()
 For those reader/writer items that support it, resets the reader/writer value to original 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 bool changedSinceLastChecked ()
 Returns true if this objects value has changed since the last time this function was called.
virtual bool peekChangedSinceLastChecked () const
 Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
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)
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 ()
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 ()
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 &)
 Restores 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)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Types

typedef std::map< DtUUID,
DtSpotReport * > 
SpotReportStdMap

Protected Member Functions

virtual bool messageNeedsUpdate () const
 Checks to see if message needs an update. Will call checkDeltaDistance and base class version if delta distance is not great enough.
virtual bool createPSR ()
 Creates the PSR.
virtual int tdlMessageType () const
 Override to specify the VRF TDL message type to create. Returns.
virtual bool sendMessage ()
 Checks to see if there are any new contacts to be sent out, any current contacts to remove or any contacts to heartbeat based on last send time.
virtual bool checkNeedsOverlayLayerSend (const DtUUID &) const
 Return true if this report is on a layer and needs to be sent.
virtual bool checkNeedsOverlayLayerSend (DtVrfObject *obj) const
virtual void sendRemovalMessage (const DtUUID &)
 Sends out a message that this is the last report for this object.
virtual void updateOrCreateContactReportsForObjectsOnOverlayLayers (const SpotReportStdMap &currentReports, const DtRwStringList &overlayLayers)
 Updates or adds contact reports for objects on any pverlay layer that wants to be checked.
virtual DtSpotReportcreateContactReportFor (DtVrfObject *, int) const
 Creates a spot report to be sent on the network as a TDL contact report based on the given entity.
virtual void updateContactReport (DtSpotReport *, DtVrfObject *) const
 Updates a spot report to be sent on the network as a TDL contact report based on the given entity.
virtual void sendContactReport (DtSpotReport *)
 Creates and sends out a contact report.
virtual bool needsContactReportHeartbeatUpdate (DtSpotReport *) const
 Returns true if this report needs an update for heartbeat.
virtual void sendRemoveAllContactReports ()
 Sends a removal message for all contact reports, but keeps them in the PSR.
virtual bool isTypeAndForceForReport (const DtUUID &contact) const
virtual bool isTypeAndForceForReport (DtVrfObject *contactEntity) const
virtual void turnTDLMessagingOff ()
 Send out final message on turning message off.
virtual DtString domainFromType (const DtEntityType &) const
 Domain (track type) of object from entity type.
- Protected Member Functions inherited from DtVrfTDLMessageGeneratorController
virtual bool fillInMessage (DtVrfTDLMessage *)
 Override to fill in the contents of the TDL message specified.
virtual void sendMessage (DtVrfTDLMessage *)
 Sends the message on the network. Override to be able to do custom sending of your message.
- Protected Member Functions inherited from DtTDLMessageGeneratorController
virtual void processSetTDLMessaging (DtSimMessage *msg)
virtual void setLocalEnabled (bool)
virtual void setGlobalEnabledOverridingLocal ()
 When called, this controller will use the global TDL messaging setting to determine if it should TDL messages.
virtual void turnTDLMessagingOn ()
virtual void readGlobalEnabledSetting (const DtBoolSetting *enabledSetting)
 If myProcessState::globalEnabledOverridingLocal() is true, the global state from the given settings object will be applied to this controller.
virtual bool canSendTDLMessages () const
 Whether or not TDL messaging is enabled for this entity.
virtual bool needsHeartbeatUpdate () const
 Returns true if the date/time difference from last send is greater than the heartbeat in the descriptor.
virtual void updatePSR ()
 Override to update the PSR with any data. Called after message is sent. Be sure to call base class on override.
virtual void registerRadioMessageCallbacks ()
 Register set callbacks.
- Protected Member Functions inherited from DtControllerComponent
 DtControllerComponent ()
 default constructor
 DtControllerComponent (const DtControllerComponent &orig)
 copy constructor
const DtControllerComponentoperator= (const DtControllerComponent &orig)
 assignment operator
virtual void setRadio (DtSimRadio *radio)
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 Compute current time and myDT.
bool testInvariant () const
virtual bool createPortGroups ()
 Called by init.
virtual bool createPorts ()
 Called by init.
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 Creates a PSR for this component and registers it with the PSR manager.
virtual void updateTaskVisualizations ()
 Called to update task visualizations after every tick.
virtual void destroyTaskVisualizations ()
 Destroys all task visualizations for this component.
virtual void destroyTaskVisualization (const DtString &name)
 Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr pointTaskVisualization (const DtString &name)
 Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr lineTaskVisualization (const DtString &name)
 Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr areaTaskVisualization (const DtString &name)
 Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr textTaskVisualization (const DtString &name)
 Finds an existing or creates a new text task visualization with the given name.
double calculateNextTaskVisTickTime () const
 Determines the next time the task visualizations should be ticked.
- 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 ()

Protected Attributes

DtTDLContactMessageGeneratorControllerDescriptormyTDLContactDescriptor
DtSensorContactInfoListChangeMonitor myContactListMonitor
DtVrfTDLRemoveMessagemyRemovalMessage
DtVrfTDLContactMessagemyContactMessage

Private Member Functions

 DtTDLContactMessageGeneratorController ()
 Not Implemented.
 DtTDLContactMessageGeneratorController (const DtTDLContactMessageGeneratorController &orig)
 Not Implemented.
DtTDLContactMessageGeneratorControlleroperator= (const DtTDLContactMessageGeneratorController &orig)
 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::vector< DtFilename > SearchPaths
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- Static Protected Member Functions inherited from DtTDLMessageGeneratorController
static void setTDLMessagingCallback (DtSimMessage *msg, void *usr)
 Individual entity TDL messaging.
static void settingConsumerCallback (const DtSettingsObject *settingsObject, void *usr)
 This is the DtSettingsConsumerFcn registered with the DtVrfSimSettingsManager to get updates when the global spot reports enabled setting changes.
- Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactorymyFactory

Member Typedef Documentation

Constructor & Destructor Documentation

DtTDLContactMessageGeneratorController::DtTDLContactMessageGeneratorController ( )
private

Not Implemented.

DtTDLContactMessageGeneratorController::DtTDLContactMessageGeneratorController ( const DtTDLContactMessageGeneratorController orig)
private

Not Implemented.

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

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtTDLContactMessageGeneratorController::~DtTDLContactMessageGeneratorController ( )
virtual

Destructor.

Member Function Documentation

DtTDLContactMessageGeneratorController& DtTDLContactMessageGeneratorController::operator= ( const DtTDLContactMessageGeneratorController orig)
private

Not Implemented.

virtual const char* DtTDLContactMessageGeneratorController::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. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns
DtTDLContactMessageGeneratorControllerType

Reimplemented from DtTDLMessageGeneratorController.

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

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns
New instance of this class.
virtual bool DtTDLContactMessageGeneratorController::messageNeedsUpdate ( ) const
protectedvirtual

Checks to see if message needs an update. Will call checkDeltaDistance and base class version if delta distance is not great enough.

Reimplemented from DtTDLMessageGeneratorController.

virtual bool DtTDLContactMessageGeneratorController::createPSR ( )
protectedvirtual

Creates the PSR.

Reimplemented from DtTDLMessageGeneratorController.

virtual int DtTDLContactMessageGeneratorController::tdlMessageType ( ) const
protectedvirtual

Override to specify the VRF TDL message type to create. Returns.

Implements DtVrfTDLMessageGeneratorController.

virtual bool DtTDLContactMessageGeneratorController::sendMessage ( )
protectedvirtual

Checks to see if there are any new contacts to be sent out, any current contacts to remove or any contacts to heartbeat based on last send time.

Reimplemented from DtVrfTDLMessageGeneratorController.

virtual bool DtTDLContactMessageGeneratorController::checkNeedsOverlayLayerSend ( const DtUUID ) const
protectedvirtual

Return true if this report is on a layer and needs to be sent.

virtual bool DtTDLContactMessageGeneratorController::checkNeedsOverlayLayerSend ( DtVrfObject obj) const
protectedvirtual
virtual void DtTDLContactMessageGeneratorController::sendRemovalMessage ( const DtUUID )
protectedvirtual

Sends out a message that this is the last report for this object.

virtual void DtTDLContactMessageGeneratorController::updateOrCreateContactReportsForObjectsOnOverlayLayers ( const SpotReportStdMap currentReports,
const DtRwStringList overlayLayers 
)
protectedvirtual

Updates or adds contact reports for objects on any pverlay layer that wants to be checked.

virtual DtSpotReport* DtTDLContactMessageGeneratorController::createContactReportFor ( DtVrfObject ,
int   
) const
protectedvirtual

Creates a spot report to be sent on the network as a TDL contact report based on the given entity.

virtual void DtTDLContactMessageGeneratorController::updateContactReport ( DtSpotReport ,
DtVrfObject  
) const
protectedvirtual

Updates a spot report to be sent on the network as a TDL contact report based on the given entity.

virtual void DtTDLContactMessageGeneratorController::sendContactReport ( DtSpotReport )
protectedvirtual

Creates and sends out a contact report.

virtual bool DtTDLContactMessageGeneratorController::needsContactReportHeartbeatUpdate ( DtSpotReport ) const
protectedvirtual

Returns true if this report needs an update for heartbeat.

virtual void DtTDLContactMessageGeneratorController::sendRemoveAllContactReports ( )
protectedvirtual

Sends a removal message for all contact reports, but keeps them in the PSR.

virtual bool DtTDLContactMessageGeneratorController::isTypeAndForceForReport ( const DtUUID contact) const
protectedvirtual
virtual bool DtTDLContactMessageGeneratorController::isTypeAndForceForReport ( DtVrfObject contactEntity) const
protectedvirtual
virtual void DtTDLContactMessageGeneratorController::turnTDLMessagingOff ( )
protectedvirtual

Send out final message on turning message off.

Reimplemented from DtTDLMessageGeneratorController.

virtual DtString DtTDLContactMessageGeneratorController::domainFromType ( const DtEntityType &  ) const
protectedvirtual

Domain (track type) of object from entity type.

Member Data Documentation

DtTDLContactMessageGeneratorControllerDescriptor* DtTDLContactMessageGeneratorController::myTDLContactDescriptor
protected
DtSensorContactInfoListChangeMonitor DtTDLContactMessageGeneratorController::myContactListMonitor
protected
DtVrfTDLRemoveMessage* DtTDLContactMessageGeneratorController::myRemovalMessage
protected
DtVrfTDLContactMessage* DtTDLContactMessageGeneratorController::myContactMessage
protected

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

Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)