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

DtEmitterComponent maintains an electromagnetic emissions publisher for a single system with one or more beams. More...

Inheritance diagram for DtEmitterComponent:
Inheritance graph
[legend]

Public Member Functions

 DtEmitterComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtEmitterComponent ()
 destructor
virtual void tick ()
 Tick the publisher if the component is on.
virtual bool tickWhileDestroyed () const
bool init ()
 Calls createAndInitEmitterSystem, #updateEmitterFromDescriptoe, determineTrackJamAbility, etc.
virtual void preFirstTickInit ()
 Calls updateEmitterFromPsr and registers nameChangedCallback.
virtual DtString type () const
 Returns a string identifies the class type of component.
virtual void registerSetRequestMsgCallbacks ()
 Registers its interest in setEmitter and setTarget messages.
virtual void processSetEmitterRequestMessage (DtSimMessage *msg)
virtual void processSetRadarModeRequestMessage (DtSimMessage *msg)
virtual void procesSetEmitterTrackJamTargetsRequestMessage (DtSimMessage *msg)
virtual void processRequestRadarModesAdmin (DtString receiver, DtString sender, bool isEchelonId, const DtVrfObjectMessage *msg)
virtual void setRadarMode (const DtString &mode)
 Sets the name of the currently targeted object.
virtual DtString radarMode () const
 Gets the name of the currently targeted object.
virtual void setTrackTargetList (const std::vector< DtString > &strings)
 Convenience method that clears the current track target list and replaces it with the given list.
virtual void setJamTargetList (const std::vector< DtString > &strings)
 Convenience method that clears the current jam target list and replaces it with the given list.
virtual void addTrackTarget (const DtString &objectName)
 All beams in the system which are tracking beams will have this entity added to their track/jam lists.
virtual void removeTrackTarget (const DtString &objectName)
 All beams in the system which are tracking beams will have this entity removed from their track/jam lists.
virtual void addJamTarget (const DtString &objectName)
 All beams in the system which are jamming beams will have this entity added to their track/jam lists.
virtual void removeJamTarget (const DtString &objectName)
 All beams in the system which are jamming beams will have this entity removed from their track/jam lists.
virtual void clearTrackTargets ()
 All tracking beams will have their track target list emptied.
virtual void clearJamTargets ()
 All jamming beams will have their jam target list emptied.
virtual DtEmitterBeamRepositoryaddBeam (DtU8 id)
 Adds a new beam if the ID does not already exist and returns a pointer to the beam repository.
virtual void removeBeam (DtU8 id)
 Removes a beam from this system.
virtual DtEmitterBeamRepositorybeam (DtU8 id=0)
 Returns a pointer to the beam repository of this beam, of NULL if there is no beam of this id in the system.
virtual int numBeams () const
 Returns total number of beams in this system.
virtual DtList * beamList ()
 Returns list to the beam repositories.
virtual DtVrfEmitterSystememitterSystem ()
 Returns the DtVrfEmitterSystem that is implementing the publishing of emitter beams.
virtual void setSystemName (DtEmitterSysName nameEnum)
virtual DtEmitterSysName systemName () const
virtual void setSystemFunction (DtEmissionFunc functionEnum)
virtual DtEmissionFunc systemFunction () const
virtual void setMountLocation (const DtVector &location)
virtual DtVector mountLocation () const
virtual void setOn (bool onOff)
 When true, EM Emissions PDUs are published as normal.
virtual bool on () const
virtual void setUseHighDensityTracking (bool useHdMode)
virtual bool useHighDensityTracking () const
virtual void setUseHighDensityJamming (bool useHdMode)
virtual bool useHighDensityJamming () const
- 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 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 (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
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 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 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)
 (const DtString&,DtVrfObject*,DtSimManager*,
static void setEmitterRequestCallback (DtSimMessage *msg, void *usrData)
static void setRadarModeRequestCallback (DtSimMessage *msg, void *usrData)
static void setEmitterTrackJamTargetsCallback (DtSimMessage *msg, void *usrData)
static void requestRadarModesAdminCallback (const DtVrfObjectMessage *msg, void *usr)
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactoryfactory ()
 A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set.
static void setFactory (DtSimComponentFactory *factory)
static DtSimComponentcreateComponent (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 chartheXmlType ()
 The type that is used when archiving to an XML stream.
static const DtFilename & appPath ()
 Gets the current working directory.
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory.
static void createReaderWriterFactory ()
static void cleanupFactory ()
static DtReaderWritercreateFromXmlFile (const DtFilename &)
 Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromXml (const DtString &)
 Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP)
 Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 Gets the named attribute from a DtEnvValueSP.
- Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType ObjectCount ()
static const DtObjectContainer * ObjectContainer ()
- Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent >
static DtObjectCounter::CounterType ObjectCount ()
static const DtObjectContainer * ObjectContainer ()

Protected Member Functions

virtual void setRadio (DtSimRadio *radio)
virtual DtSimRadioradio ()
 The radio this component is listening to.
virtual bool createAndInitEmitterSystem ()
 Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.
virtual void updateEmitterFromDescriptor ()
 Copies data from this components descriptor into the state repository.
virtual void updateEmitterFromPsr ()
 Conditionally updates the emitter system based on PSR or descriptor defaults.
virtual void determineTrackJamAbility ()
 Iterates over the beam descriptors to find out if we need to register for track/jam messages.
virtual bool createPSR ()
 Creates myProcessState data member, and adds it to our process state repository manager.
- 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 ()

Protected Attributes

DtSimRadiomyRadio
DtVrfEmitterSystemmyEmitterSystem
DtU8 myEmitterSystemId
bool myRegisterForTrackMessages
 Set up in init by determineTrackJamAbility.
bool myRegisterForJamMessages
DtEmitterPSRmyProcessState
 Container for state data associated with this component.
- Protected Attributes inherited from DtSimComponent
DtVrfObjectmyEntity
DtVrfObjectStateRepositorymyLocalStateRepository
DtSimManagermySimManager
DtComponentSystemmySystem
 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 DtComponentDescriptormyComponentDescriptor
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
DtReaderWriterRegistrymyParentRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
DtReaderWritermyDefaultValue
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.

Private Member Functions

 DtEmitterComponent ()
 Default constructor; not implemented.
 DtEmitterComponent (const DtEmitterComponent &orig)
 copy constructor; not implemented.
const DtEmitterComponentoperator= (const DtEmitterComponent &orig)
 assignment operator; not implemented.
virtual void processNameChanged (const DtVrfObjectNameChangedCallbackInfo &changeInfo)
 Handles keeping the PSR in sync with renaming.
static void nameChangedCallback (const DtVrfObjectNameChangedCallbackInfo &changeInfo, void *usrData)
 Handles keeping the PSR in sync with renaming.

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 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 DtSimComponentFactorymyFactory

Detailed Description

DtEmitterComponent maintains an electromagnetic emissions publisher for a single system with one or more beams.

End User Description: All elements of the beam characteristics (azimuth, elevation, etc.) are settable through the emitter-component-descriptor. All of these parameters are static. If the user desires dynamic beam characteristics (i.e. radar sweeps), they must derive from this class to provide that functionallity. API calls for that type of interaction are provided. The DtEmitterComponent does provide for turning the component on and off. When off, the component will publish the emitter system only, with 0 beams attached to it. DtEmitterComponent also provides for some simple target tracking. Since this component is independent from any sensing logic, it cannot provide realistic target tracking. It does provide an API for adding and removing targets from all beams in the system, and can be set to "Targeting Capable" mode in which the component will automatically set the beams to track any entity that is specified as the "Target" through the "set-target" radio message. This calss uses the DtVrfEmitterSystem class internally to simulate the emitter.

Uses Descriptor Type: DtEmitterComponentDescriptor

Constructor & Destructor Documentation

DtEmitterComponent::DtEmitterComponent ( 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 DtEmitterComponent::~DtEmitterComponent ( )
virtual

destructor

DtEmitterComponent::DtEmitterComponent ( )
private

Default constructor; not implemented.

DtEmitterComponent::DtEmitterComponent ( const DtEmitterComponent orig)
private

copy constructor; not implemented.

Member Function Documentation

virtual void DtEmitterComponent::tick ( )
virtual

Tick the publisher if the component is on.

Reimplemented from DtSimComponent.

virtual bool DtEmitterComponent::tickWhileDestroyed ( ) const
virtual
Returns
true. Necessary in order to stop publishing emitter system when entity is destroyed.

Reimplemented from DtSimComponent.

bool DtEmitterComponent::init ( )
virtual

Calls createAndInitEmitterSystem, #updateEmitterFromDescriptoe, determineTrackJamAbility, etc.

Reimplemented from DtSimComponent.

virtual void DtEmitterComponent::preFirstTickInit ( )
virtual

Calls updateEmitterFromPsr and registers nameChangedCallback.

Reimplemented from DtSimComponent.

virtual DtString DtEmitterComponent::type ( ) const
virtual

Returns a string identifies the class type of component.

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

Returns
DtEmitterComponentType

Reimplemented from DtSimComponent.

static DtSimComponent* DtEmitterComponent::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 void DtEmitterComponent::registerSetRequestMsgCallbacks ( )
virtual

Registers its interest in setEmitter and setTarget messages.

static void DtEmitterComponent::setEmitterRequestCallback ( DtSimMessage msg,
void *  usrData 
)
static
virtual void DtEmitterComponent::processSetEmitterRequestMessage ( DtSimMessage msg)
virtual
static void DtEmitterComponent::setRadarModeRequestCallback ( DtSimMessage msg,
void *  usrData 
)
static
virtual void DtEmitterComponent::processSetRadarModeRequestMessage ( DtSimMessage msg)
virtual
static void DtEmitterComponent::setEmitterTrackJamTargetsCallback ( DtSimMessage msg,
void *  usrData 
)
static
virtual void DtEmitterComponent::procesSetEmitterTrackJamTargetsRequestMessage ( DtSimMessage msg)
virtual
static void DtEmitterComponent::requestRadarModesAdminCallback ( const DtVrfObjectMessage msg,
void *  usr 
)
static
virtual void DtEmitterComponent::processRequestRadarModesAdmin ( DtString  receiver,
DtString  sender,
bool  isEchelonId,
const DtVrfObjectMessage msg 
)
virtual
static void DtEmitterComponent::nameChangedCallback ( const DtVrfObjectNameChangedCallbackInfo changeInfo,
void *  usrData 
)
static

Handles keeping the PSR in sync with renaming.

virtual void DtEmitterComponent::processNameChanged ( const DtVrfObjectNameChangedCallbackInfo changeInfo)
virtual

Handles keeping the PSR in sync with renaming.

virtual void DtEmitterComponent::setSystemName ( DtEmitterSysName  nameEnum)
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual DtEmitterSysName DtEmitterComponent::systemName ( ) const
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual void DtEmitterComponent::setSystemFunction ( DtEmissionFunc  functionEnum)
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual DtEmissionFunc DtEmitterComponent::systemFunction ( ) const
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual void DtEmitterComponent::setMountLocation ( const DtVector location)
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual DtVector DtEmitterComponent::mountLocation ( ) const
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual void DtEmitterComponent::setOn ( bool  onOff)
virtual

When true, EM Emissions PDUs are published as normal.

Otherwise, the emitter system is still published, but without any beams.

virtual bool DtEmitterComponent::on ( ) const
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual void DtEmitterComponent::setUseHighDensityTracking ( bool  useHdMode)
virtual

Accessors for the emitter's High-Density track/jam indicator on or off. When on, the receiving simulation is responsible for determining which entities are actually tracked/jammed. When off, the track/jam lists are populated explicitly, and should be used instead.

virtual bool DtEmitterComponent::useHighDensityTracking ( ) const
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual void DtEmitterComponent::setUseHighDensityJamming ( bool  useHdMode)
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual bool DtEmitterComponent::useHighDensityJamming ( ) const
virtual

Accessor and mutators for properties of the beam and emitter system.

virtual void DtEmitterComponent::setRadarMode ( const DtString mode)
virtual

Sets the name of the currently targeted object.

virtual DtString DtEmitterComponent::radarMode ( ) const
virtual

Gets the name of the currently targeted object.

virtual void DtEmitterComponent::setTrackTargetList ( const std::vector< DtString > &  strings)
virtual

Convenience method that clears the current track target list and replaces it with the given list.

virtual void DtEmitterComponent::setJamTargetList ( const std::vector< DtString > &  strings)
virtual

Convenience method that clears the current jam target list and replaces it with the given list.

virtual void DtEmitterComponent::addTrackTarget ( const DtString objectName)
virtual

All beams in the system which are tracking beams will have this entity added to their track/jam lists.

virtual void DtEmitterComponent::removeTrackTarget ( const DtString objectName)
virtual

All beams in the system which are tracking beams will have this entity removed from their track/jam lists.

virtual void DtEmitterComponent::addJamTarget ( const DtString objectName)
virtual

All beams in the system which are jamming beams will have this entity added to their track/jam lists.

virtual void DtEmitterComponent::removeJamTarget ( const DtString objectName)
virtual

All beams in the system which are jamming beams will have this entity removed from their track/jam lists.

virtual void DtEmitterComponent::clearTrackTargets ( )
virtual

All tracking beams will have their track target list emptied.

virtual void DtEmitterComponent::clearJamTargets ( )
virtual

All jamming beams will have their jam target list emptied.

virtual DtEmitterBeamRepository* DtEmitterComponent::addBeam ( DtU8  id)
virtual

Adds a new beam if the ID does not already exist and returns a pointer to the beam repository.

virtual void DtEmitterComponent::removeBeam ( DtU8  id)
virtual

Removes a beam from this system.

virtual DtEmitterBeamRepository* DtEmitterComponent::beam ( DtU8  id = 0)
virtual

Returns a pointer to the beam repository of this beam, of NULL if there is no beam of this id in the system.

virtual int DtEmitterComponent::numBeams ( ) const
virtual

Returns total number of beams in this system.

virtual DtList* DtEmitterComponent::beamList ( )
virtual

Returns list to the beam repositories.

virtual DtVrfEmitterSystem* DtEmitterComponent::emitterSystem ( )
virtual

Returns the DtVrfEmitterSystem that is implementing the publishing of emitter beams.

When possible, use the other interface methods in this component instead of calling down to the emitter system directly.

virtual void DtEmitterComponent::setRadio ( DtSimRadio radio)
protectedvirtual
virtual DtSimRadio* DtEmitterComponent::radio ( )
protectedvirtual

The radio this component is listening to.

virtual bool DtEmitterComponent::createAndInitEmitterSystem ( )
protectedvirtual

Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.

virtual void DtEmitterComponent::updateEmitterFromDescriptor ( )
protectedvirtual

Copies data from this components descriptor into the state repository.

virtual void DtEmitterComponent::updateEmitterFromPsr ( )
protectedvirtual

Conditionally updates the emitter system based on PSR or descriptor defaults.

virtual void DtEmitterComponent::determineTrackJamAbility ( )
protectedvirtual

Iterates over the beam descriptors to find out if we need to register for track/jam messages.

virtual bool DtEmitterComponent::createPSR ( )
protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

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

assignment operator; not implemented.

Member Data Documentation

DtSimRadio* DtEmitterComponent::myRadio
protected
DtVrfEmitterSystem* DtEmitterComponent::myEmitterSystem
protected
DtU8 DtEmitterComponent::myEmitterSystemId
protected
bool DtEmitterComponent::myRegisterForTrackMessages
protected
bool DtEmitterComponent::myRegisterForJamMessages
protected
DtEmitterPSR* DtEmitterComponent::myProcessState
protected

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).


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)