VR-Forces 4.3.1 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
DtJammerController Class Reference

End User Description: DtJammerController turns the jammer on and off using Set commands. More...

Inheritance diagram for DtJammerController:
Inheritance graph
[legend]

Public Member Functions

 DtJammerController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString& name,
virtual ~DtJammerController ()
 destructor
virtual DtString type () const
 This returns a string from compTypes.h, and identifies the type of component.
virtual void tick ()
 Tick the publisher if the component is on.
virtual bool tickWhileDestroyed () const
bool init ()
 Creates the PSR, sets myDescriptor, creates and inits the emitter system, registers attribute access functions, and registers for setEmitter messages.
virtual void setOn (bool onOff)
 When true, EM Emissions PDUs are published.
virtual bool on () const
virtual void setMountLocation (const DtVector &location)
virtual DtVector mountLocation () const
virtual void setSystemNameEnum (DtEmitterSysName nameEnum)
virtual DtEmitterSysName systemNameEnum () const
virtual void setSystemFunction (DtEmissionFunc functionEnum)
virtual DtEmissionFunc systemFunction () const
virtual DtVrfEmitterSystememitterSystem ()
 Returns the DtVrfEmitterSystem that is implementing the publishing of emitter beams.
- 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 preprocess ()
 Perform parallel preprocessing prior to tick and similar computations.
virtual void parallelTick ()
 called in parallel
virtual void preFirstTickInit ()
 called from preprocess if appropriate
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 DtReaderWriterprovideIsJammerOn (void *ctrlr)
 Attribute access functions.
static DtReaderWriterprovideJammingStrength (void *ctrlr)
 Provides the comms jamming strength of the system.
static DtReaderWriterprovideJammingRange (void *ctrlr)
 Provides the comms jamming range of the system.
static DtReaderWriterprovideJammerType (void *ctrlr)
 Provides the type of the system ("comms", "radar", etc.)
static DtReaderWriterprovideAllowedPostures (void *ctrlr)
 Provides the string of space or comma-delimited names of.

Protected Member Functions

virtual bool createAndInitEmitterSystem ()
 Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.
virtual void updateFromDescriptor ()
 copies data from this components descriptor into the state repository.
virtual DtList * beamList ()
 Returns list to the beam repositories.
virtual bool createPSR ()
 Creates myProcessState data member, and adds it to our process state repository manager.
virtual const
DtJammerEmitterDescriptor
getDescriptor ()
 Gets the descriptor for use in the provider functions.
virtual DtJammerPSRgetPSR ()
 Gets the PSR for use in the provider functions.
- 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, 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

DtJammerPSRmyProcessState
const DtJammerEmitterDescriptormyDescriptor
DtVrfEmitterSystemmyEmitterSystem
 Local copies of the emitter information.
bool myStateRestored
 Set to true once previously checkpointed state (if any) is restored.
DtU8 myEmitterSystemId
 Local copies of the emitter information.
- Protected Attributes inherited from DtControllerComponent
DtSimRadiomyRadio
 Controller components can send messages.
- 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

 DtJammerController ()
 Not implemented.
 DtJammerController (const DtJammerController &orig)
 Not implemented.
const DtJammerControlleroperator= (const DtJammerController &orig)
 Not implemented.
virtual void processSetEmitterRequestMessage (DtSimMessage *msg)
 Calls setEmitterSystemOn() with the value specified in the message if the message matches our emitter system ID.
static void setEmitterRequestCallback (DtSimMessage *msg, void *usrData)
 Handle setEmitter (on/off)Static callback method for setEmitter messages.
void processRequestRadarModesAdmin (DtString receiver, DtString sender, bool isEchelonId, const DtVrfObjectMessage *msg)
 Handle requestRadarModes.
static void requestRadarModesAdminCallback (const DtVrfObjectMessage *msg, void *usr)
 Handle requestRadarModes.

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

End User Description: DtJammerController turns the jammer on and off using Set commands.

It also publishes emitter info.
Developer Description: The DtJammerController class extends the base DtControllerComponent. It does not implement any tasks, but implements sets for turning comms and radar jamming on and off. It uses some of the same code as DtEmmitterComponent.

Constructor & Destructor Documentation

DtJammerController::DtJammerController ( )
private

Not implemented.

DtJammerController::DtJammerController ( const DtJammerController orig)
private

Not implemented.

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

(const DtString& name,

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& name, DtVrfObject* owner, DtSimManager* simManager, DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0)

virtual DtJammerController::~DtJammerController ( )
virtual

destructor

Member Function Documentation

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

Not implemented.

virtual DtString DtJammerController::type ( ) const
virtual

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

Reimplemented from DtControllerComponent.

virtual void DtJammerController::tick ( )
virtual

Tick the publisher if the component is on.

Reimplemented from DtSimComponent.

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

Reimplemented from DtSimComponent.

bool DtJammerController::init ( )
virtual

Creates the PSR, sets myDescriptor, creates and inits the emitter system, registers attribute access functions, and registers for setEmitter messages.

Reimplemented from DtControllerComponent.

static DtReaderWriter* DtJammerController::provideIsJammerOn ( void *  ctrlr)
static

Attribute access functions.

These functions are registered with the parent system in init().

Provides an indication of whether the jammer is on.

static DtReaderWriter* DtJammerController::provideJammingStrength ( void *  ctrlr)
static

Provides the comms jamming strength of the system.

static DtReaderWriter* DtJammerController::provideJammingRange ( void *  ctrlr)
static

Provides the comms jamming range of the system.

static DtReaderWriter* DtJammerController::provideJammerType ( void *  ctrlr)
static

Provides the type of the system ("comms", "radar", etc.)

static DtReaderWriter* DtJammerController::provideAllowedPostures ( void *  ctrlr)
static

Provides the string of space or comma-delimited names of.

tactical postures that jamming can be used in.

static DtSimComponent* DtJammerController::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 DtJammerController::setOn ( bool  onOff)
virtual

When true, EM Emissions PDUs are published.

virtual bool DtJammerController::on ( ) const
virtual
virtual void DtJammerController::setMountLocation ( const DtVector location)
virtual
virtual DtVector DtJammerController::mountLocation ( ) const
virtual
virtual void DtJammerController::setSystemNameEnum ( DtEmitterSysName  nameEnum)
virtual
virtual DtEmitterSysName DtJammerController::systemNameEnum ( ) const
virtual
virtual void DtJammerController::setSystemFunction ( DtEmissionFunc  functionEnum)
virtual
virtual DtEmissionFunc DtJammerController::systemFunction ( ) const
virtual
virtual DtVrfEmitterSystem* DtJammerController::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 bool DtJammerController::createAndInitEmitterSystem ( )
protectedvirtual

Creates a new DtVrfEmitterSystem and assigns it to myEmitterSystem.

virtual void DtJammerController::updateFromDescriptor ( )
protectedvirtual

copies data from this components descriptor into the state repository.

virtual DtList* DtJammerController::beamList ( )
protectedvirtual

Returns list to the beam repositories.

static void DtJammerController::setEmitterRequestCallback ( DtSimMessage msg,
void *  usrData 
)
staticprotected

Handle setEmitter (on/off)Static callback method for setEmitter messages.

Calls processSetEmitterRequestMessage().

virtual void DtJammerController::processSetEmitterRequestMessage ( DtSimMessage msg)
protectedvirtual

Calls setEmitterSystemOn() with the value specified in the message if the message matches our emitter system ID.

static void DtJammerController::requestRadarModesAdminCallback ( const DtVrfObjectMessage msg,
void *  usr 
)
staticprotected

Handle requestRadarModes.

The jammer doesn't (currently) have settable modes; it does indicate either radar or comms jamming. This will also enable the info panel in the GUI to display beam information.

void DtJammerController::processRequestRadarModesAdmin ( DtString  receiver,
DtString  sender,
bool  isEchelonId,
const DtVrfObjectMessage msg 
)
protected

Handle requestRadarModes.

The jammer doesn't (currently) have settable modes; it does indicate either radar or comms jamming. This will also enable the info panel in the GUI to display beam information.

virtual bool DtJammerController::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.

virtual const DtJammerEmitterDescriptor* DtJammerController::getDescriptor ( )
protectedvirtual

Gets the descriptor for use in the provider functions.

virtual DtJammerPSR* DtJammerController::getPSR ( )
protectedvirtual

Gets the PSR for use in the provider functions.

Member Data Documentation

DtJammerPSR* DtJammerController::myProcessState
protected
const DtJammerEmitterDescriptor* DtJammerController::myDescriptor
protected
DtVrfEmitterSystem* DtJammerController::myEmitterSystem
protected

Local copies of the emitter information.

Not saved in the PSR, but restored on scenario reload.

bool DtJammerController::myStateRestored
protected

Set to true once previously checkpointed state (if any) is restored.

DtU8 DtJammerController::myEmitterSystemId
protected

Local copies of the emitter information.

Not saved in the PSR, but restored on scenario reload.


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

Document ID: Generated on Wed Jul 29 00:55:00 EDT 2015 from SVN revision 155257
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)