![]() |
VR-Forces 4.2 Class Documentation
|
DtIffControllerComponent is a controller that manages a IFF publisher for an entity. More...

Public Member Functions | |
| DtIffControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| virtual | ~DtIffControllerComponent () |
| destructor | |
| virtual bool | init () |
| Calls setRadio() | |
| virtual void | preFirstTickInit () |
| If IFF information is specified in myProcessState, calls updateFromSetRequest(). | |
| virtual void | tick () |
| Calls updateDynamicData() and if needsToTick() calls tick on myIffPublisher. | |
| virtual DtString | type () const |
| Returns a string identifies the class type of component. | |
| virtual void | registerSetIffRequestMsgCallbacks () |
| Registers its interest in set IFF request messages. | |
| virtual void | processSetIffRequestMessage (DtSimMessage *msg) |
| virtual DtVrfIffPSR * | getPsr () |
| Access function for the PSR so that attribute query functions can provide data from them. | |
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 DtSimBaseRadio * | radio () |
| 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 | 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 DtSimComponent * | nextComponent () |
| List management functions. | |
| virtual DtSimComponent * | prevComponent () |
| 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 DtFilename &searchPath, 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 DtInputPort * | lookupInputPort (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 DtOutputPort * | lookupOutputPort (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 DtInputPortGroup * | lookupInputPortGroup (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 DtOutputPortGroup * | lookupOutputPortGroup (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. | |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| virtual DtString | componentFullName () const |
| virtual DtPhysicalWorld * | physicalWorld () |
| Gets the physical world that this component's entity exists in. | |
| virtual const DtPhysicalWorld * | physicalWorld () const |
| virtual DtAttachedTerrain * | terrainAttachedTo () |
| Gets the terrain that this component's entity is attached to, if any. | |
| virtual const DtAttachedTerrain * | terrainAttachedTo () const |
| virtual DtVrfObject * | entity () |
| Gets the entity. | |
| virtual const DtVrfObject * | entity () const |
| virtual DtSimManager * | simManager () |
| Gets the sim manager. | |
| virtual const DtSimManager * | simManager () 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 DtOutputStream & | objectConsoleDebug () const |
| virtual DtOutputStream & | objectConsoleVerbose () const |
| virtual DtOutputStream & | objectConsoleInfo () const |
| virtual DtOutputStream & | objectConsoleWarn () const |
| virtual DtOutputStream & | objectConsoleError () const |
| virtual DtSimResourceManager & | resourceManager () |
| 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) | |
| copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| const DtReaderWriter & | operator= (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 | getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| 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 aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| virtual bool | isReadonly () const |
| 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 char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| 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 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. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Static Public Member Functions | |
| static DtSimComponent * | creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| (const DtString&,DtVrfObject*,DtSimManager*, | |
| static void | setIffRequestCallback (DtSimMessage *msg, void *usrData) |
Protected Member Functions | |
| DtIffControllerComponent () | |
| Default constructor; should not be called. | |
| DtIffControllerComponent (const DtIffControllerComponent &orig) | |
| copy constructor; shallow; does not copy the ports. | |
| const DtIffControllerComponent & | operator= (const DtIffControllerComponent &orig) |
| assignment operator; see comments on copy constructor! | |
| virtual void | setRadio (DtSimBaseRadio *radio) |
| Override this so we can register interest in IFF messages. | |
| virtual bool | createPublisher () |
| virtual void | updateFromDescriptor () |
| Updates current state from the descriptor owned by this controller. | |
| virtual void | updateFromSetRequest (DtSetIffRequest *setReq, bool updateInPSR=true) |
| Updates current state from the specified set iff request message. | |
| virtual void | updateDynamicData () |
| Updates data that periodically updates from the entity state (i.e. Mode5 Altitude) | |
| virtual bool | needsToTick () |
| Returns true if the publisher should be ticked. | |
| virtual bool | createPSR () |
| Creates myProcessState data member, and adds it to our process state repository manager. | |
Protected Member Functions inherited from DtControllerComponent | |
| DtControllerComponent () | |
| default constructor | |
| DtControllerComponent (const DtControllerComponent &orig) | |
| copy constructor | |
| const DtControllerComponent & | operator= (const DtControllerComponent &orig) |
| assignment operator | |
Protected Member Functions inherited from DtSimComponent | |
| 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. | |
| 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 DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
Protected Attributes | |
| DtIffPublisher * | myIffPublisher |
| bool | myHasBeenTicked |
| bool | myUseAltMode5 |
| set to true once the IFF is used for the first time. | |
| DtVrfIffPSR * | myProcessState |
| True if we are currently using alternate mode 5C. | |
Protected Attributes inherited from DtControllerComponent | |
| DtSimBaseRadio * | myRadio |
| Controller components can send messages. | |
Protected Attributes inherited from DtSimComponent | |
| DtVrfObject * | myEntity |
| DtVrfObjectStateRepository * | myLocalStateRepository |
| DtSimManager * | mySimManager |
| DtComponentSystem * | mySystem |
| 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 DtComponentDescriptor * | myComponentDescriptor |
Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| 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. | |
| virtual void | registerAttributeFunctions () |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideSystemOn (void *controller) |
| Functions to be registered as a provider with the parent component system for various IFF status attributes. | |
| static DtReaderWriter * | provideMode1On (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideMode1Code (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideMode2On (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideMode2Code (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideMode3On (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideMode3Code (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideMode4On (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideMode4Code (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideAltMode4Value (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideMode5On (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideAltMode5On (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideModeSOn (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideModeSTcasI (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideEmergency (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideFlash (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
| static DtReaderWriter * | provideSTI (void *controller) |
| Attribute functions:Overrides the simComponent version to register the functions below. | |
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::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 DtSimComponentFactory * | myFactory |
DtIffControllerComponent is a controller that manages a IFF publisher for an entity.
Uses Descriptor Type: DtIffControllerDescriptor
| DtIffControllerComponent::DtIffControllerComponent | ( | const DtString & | name, |
| DtVrfObject * | owner, | ||
| DtSimManager * | simManager, | ||
| DtComponentDescriptor * | desc = 0, |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
(const DtString&,DtVrfObject*,DtSimManager*,
| name | Reader writer name of this component. |
| owner | The DtVrfObject that owns this component |
| simManager | The simulation manager (provides access to terrain, message interface, simulation clock). |
| desc | The component descriptor used to initialize this component. |
| parentRegistry | Pointer to the parent reader writer registry (the containing object that reads/writes this object). |
|
virtual |
destructor
|
protected |
Default constructor; should not be called.
Here because the compiler will generate an unprotected one otherwise.
|
protected |
copy constructor; shallow; does not copy the ports.
|
virtual |
Calls setRadio()
Reimplemented from DtControllerComponent.
|
virtual |
If IFF information is specified in myProcessState, calls updateFromSetRequest().
Reimplemented from DtSimComponent.
|
virtual |
Calls updateDynamicData() and if needsToTick() calls tick on myIffPublisher.
Reimplemented from DtSimComponent.
|
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.
Reimplemented from DtControllerComponent.
|
static |
(const DtString&,DtVrfObject*,DtSimManager*,
| name | Reader writer name of this component. |
| owner | The DtVrfObject that owns this component |
| simManager | The simulation manager (provides access to terrain, message interface, simulation clock). |
| desc | The component descriptor used to initialize this component. |
| parentRegistry | Pointer to the parent reader writer registry (the containing object that reads/writes this object). |
|
virtual |
Registers its interest in set IFF request messages.
|
static |
|
virtual |
|
virtual |
Access function for the PSR so that attribute query functions can provide data from them.
|
virtual |
Attribute functions:Overrides the simComponent version to register the functions below.
Reimplemented from DtSimComponent.
|
static |
Functions to be registered as a provider with the parent component system for various IFF status attributes.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
static |
Attribute functions:Overrides the simComponent version to register the functions below.
|
protected |
assignment operator; see comments on copy constructor!
|
protectedvirtual |
Override this so we can register interest in IFF messages.
Reimplemented from DtControllerComponent.
|
protectedvirtual |
|
protectedvirtual |
Updates current state from the descriptor owned by this controller.
|
protectedvirtual |
Updates current state from the specified set iff request message.
|
protectedvirtual |
Updates data that periodically updates from the entity state (i.e. Mode5 Altitude)
|
protectedvirtual |
Returns true if the publisher should be ticked.
The publisher is not ticked if all the IFF modes are off, and have never been turned on. Once any mode is turned on, the publisher is always ticked, even if the mode is later turned off.
|
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.
|
protected |
|
protected |
|
protected |
set to true once the IFF is used for the first time.
|
protected |
True if we are currently using alternate mode 5C.
Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).