Public Member Functions |
| | DtTurretActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) |
| | (const DtString&,DtVrfObject*,DtSimManager*,
|
| virtual | ~DtTurretActuatorComponent () |
| | destructor
|
| virtual bool | postAddComponentsInit () |
| | Calls lookupAndCacheProcessSR() and initProcessSR()
|
| virtual DtString | type () const |
| | Returns a string identifies the class type of component.
|
| virtual void | tick () |
| | Calculate new kinematic state.
|
| virtual void | setTurretArtPart (DtArtPartType turretArtPart) |
| virtual DtArtPartType | turretArtPart () const |
| virtual void | setMaxSlewRate (DtReal maxSlewRate) |
| virtual DtReal | maxSlewRate () const |
| virtual void | initProcessSR () |
| | Sets the art part type and slew rate in myProcessState from the DtSimArtPartDescriptor.
|
| virtual | ~DtActuatorComponent () |
| | destructor
|
| virtual bool | init () |
| | Overridden to cache a pointer to the entity's radio in this class.
|
| virtual DtSimBaseRadio * | radio () |
| virtual bool | tickWhileDestroyed () const |
| | By default, all actuators tick when the entity is destroyed.
|
| | 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 void | registerAttributeFunctions () |
| | Called to register functions that provide system attribute values.
|
| virtual void | preFirstTickInit () |
| | This function can be overridden to initialize a component before it is ticked for the first time.
|
| virtual void | postTick () |
| | This function is called immediately after tick() is called.
|
| virtual void | timedTick () |
| | This version of tick checks to see if the time to tick has arrived.
|
| virtual void | setMinTickPeriod (double minTickPeriod) |
| | specifies a minimum tick period (which can also be thought of as
|
| virtual double | minTickPeriod () const |
| | access the minimum tick period
|
| virtual void | setMinTickPeriodVariance (double minTickPeriodVariance) |
| | set the variance in the minimum tick time
|
| virtual double | minTickPeriodVariance () const |
| | access the variance in the minimum tick period
|
| virtual void | setNextTickTime (double nextTickTime) |
| | The next tick time is normally calculated internally.
|
| virtual double | nextTickTime () const |
| | access the next tick time
|
| virtual double | calculateNextTickTime () const |
| | The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
|
| virtual double | calculateFirstTickTime () const |
| | Returns the first time value that the component should tick at.
|
| virtual void | setEntity (DtVrfObject *entity) |
| | The entity's state repository is the place that actuator components make updates and other components look to see our current state.
|
| virtual 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 |
| 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 |
| | 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.
|
DtTurretActuatorComponent provides a simple model of a rotating turret that knows how to drive the articulating parts objects of the local state repository.
End User Description: The turret actuator updates the articulated part specified in its component descriptor, based on slew data it receives. It expects an input (via a mySlewPort) of a slew amount between -1. and +1.
Developer Description: The tick() function first checks to see if dT is 0.0. If it is, it just returns. Otherwise, it looks up the DtArticulatedPartStateRepository object kept by the entity to maintain state for the turret using DtAttachmentManager::findPartByType with the turret art part type from the process state repository as the argument. The current angle of the turret (with respect to whatever is it attached to) is retrieved from the DtArticulatedPartStateRepository which represents the turret by going through the kinematic state to get the "psi" component of the parent orientation. The slewRate to use is calculated using: the value on the slew port * myMaxSlewRate The new turret angle is calculated as: the current angle + (slew rate * dT) The angle is then constrained to be between 0.0 and 2 * PI using the VR-Link utility function DtModPerLo(). The new angle is then stored in the kinematic state of the rotating body.
Uses Descriptor Type: DtTurretComponentDescriptor