![]() |
VR-Forces Developer's Guide
|
End User Description: Actuator for moving aggregated subsurface aggregates. This actuator enforces environment constraints appropriate to a submarine. The aggregate is treated as a point object when moving using this actuator. Uses Descriptor Type: DtActuatorComponentDescriptor.

Public Member Functions | |
| DtAggregatedSubsurfaceMovementActuator (const DtString &name, DtLocalObject *object, DtSimulationServices *simManager, DtComponentDescriptor *compDescriptor, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtAggregatedSubsurfaceMovementActuator () override |
| virtual const char * | type () const override |
| virtual void | setOrderedAltitude (double altitude, bool isAboveGroundLevel=false) override |
Public Member Functions inherited from DtAggregatedMovementActuator | |
| DtAggregatedMovementActuator (const DtString &name, DtLocalObject *object, DtSimulationServices *simManager, DtComponentDescriptor *compDescriptor, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtAggregatedMovementActuator () override |
| virtual bool | init () override |
| virtual bool | createPSR () |
| virtual void | tick () override |
Public Member Functions inherited from DtActuatorComponent | |
| virtual | ~DtActuatorComponent () override |
| virtual DtSimRadio * | radio () |
| virtual bool | tickWhileDestroyed () const override |
Public Member Functions inherited from DtSimComponent | |
| DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0) | |
| virtual | ~DtSimComponent () override |
| virtual void | setParentSystem (DtComponentSystem *system) |
| DtComponentSystem * | parentSystem () const |
| virtual bool | postAddComponentsInit () |
| virtual void | registerAttributeFunctions () |
| virtual void | preFirstTickInit () |
| virtual void | postTick () |
| virtual void | timedTick () |
| virtual void | setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance) |
| virtual void | setupFirstTickTime () |
| virtual void | setEntity (DtLocalObject *entity) |
| virtual DtSimComponent * | nextComponent () |
| virtual DtSimComponent * | prevComponent () |
| virtual void | setListItem (DtListItem *item) |
| virtual DtListItem * | listItem () |
| virtual void | putData (std::string &fp, int indentLevel=0) override |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override |
| virtual void | addInputPort (DtInputPort *port) |
| virtual void | removeInputPort (DtInputPort *port) |
| virtual DtInputPort * | lookupInputPort (const DtString &portName) |
| virtual DtList | inputPortList () const |
| virtual void | addOutputPort (DtOutputPort *port) |
| virtual void | removeOutputPort (DtOutputPort *port) |
| virtual DtOutputPort * | lookupOutputPort (const DtString &portName) |
| virtual DtList | outputPortList () const |
| virtual void | addInputPortGroup (DtInputPortGroup *group) |
| virtual void | removeInputPortGroup (DtInputPortGroup *group) |
| virtual DtInputPortGroup * | lookupInputPortGroup (const DtString &groupName) |
| virtual DtList | inputPortGroupList () const |
| virtual void | addOutputPortGroup (DtOutputPortGroup *group) |
| virtual void | removeOutputPortGroup (DtOutputPortGroup *group) |
| virtual DtOutputPortGroup * | lookupOutputPortGroup (const DtString &groupName) |
| virtual DtList | outputPortGroupList () const |
| virtual int | priority () const |
| virtual void | setPriority (int priority) |
| double | dT () const |
| virtual void | setDT (double deltaT) |
| virtual void | setComponentDescriptor (DtComponentDescriptor *componentDescriptor) |
| virtual const DtComponentDescriptor * | componentDescriptor () const |
| DtVrfProcessStateRepositoryManager * | psrManager () |
| virtual const DtSymbolString & | componentFullName () const |
| DtPhysicalWorld * | physicalWorld () |
| const DtPhysicalWorld * | physicalWorld () const |
| const DtAttachedTerrain * | terrainAttachedTo () const |
| DtLocalObject * | entity () |
| const DtLocalObject * | entity () const |
| DtSimulationServices * | simulationServices () |
| const DtSimulationServices * | simulationServices () const |
| const Coordinate_System * | coordinateSystem () const |
| virtual void | isClutterChanged () |
| virtual bool | taskVisualizationsActive () const |
| virtual bool | taskVisualizationsEnabled () const |
| virtual void | onRestore () |
| makVrf::DtTaskVisualizationMap & | taskVisualizations () |
| virtual void | updateImgui () |
| virtual bool | debugActive () const |
| virtual void | enable () |
| virtual void | disable () |
| virtual bool | isEnabled () |
| virtual void | setIsEnabled (bool yesNo) |
| virtual DtOutputStream & | objectConsoleDebug (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleVerbose (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleInfo (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleWarn (const DtString &channel="") const |
| virtual DtOutputStream & | objectConsoleError (const DtString &channel="") const |
| virtual int | notifyLevel () const |
| virtual DtSimResourceManager & | resourceManager () |
| virtual const DtSimResourceManager & | resourceManager () const |
| VRF4API_METHOD const DtSimulationServices * | simManager () const |
Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| bool | operator== (const DtReaderWriter &) const |
| bool | operator!= (const DtReaderWriter &rhs) const |
| virtual | ~DtReaderWriter () |
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| virtual void | postPutSelf () |
| virtual void | prePutSelf () |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| virtual void | postGetSelf () |
| virtual void | preGetSelf () |
| virtual void | writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| virtual DtSymbolString | name () const |
| virtual void | addAlias (const DtSymbolString &alias) |
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| bool | isReadonly () const |
| virtual void | reset () |
| virtual int | alignment () const |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| virtual void | setName (const DtString &) |
| virtual const char * | readerWriterType () const |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| virtual bool | hasVariableReference () const |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| virtual void | recordUpdateTime () const |
| virtual bool | changedSinceLastChecked () |
| virtual bool | peekChangedSinceLastChecked () const |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| virtual DtSymbolString | variableName () const |
| virtual void | setVariableName (const DtSymbolString variableName) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| const DtReaderWriterRegistry & | registry () const |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| virtual bool | toXml (const DtFilename &) const |
| virtual bool | fromXml (const DtString &) |
| virtual bool | fromXmlFile (const DtFilename &) |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| 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()) |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| DtAggregatedSubsurfaceMovementActuator::DtAggregatedSubsurfaceMovementActuator | ( | const DtString & | name, |
| DtLocalObject * | object, | ||
| DtSimulationServices * | simManager, | ||
| DtComponentDescriptor * | compDescriptor, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
|
overridevirtual |
destructor
|
protected |
copy constructor - not implemented
|
overridevirtual |
Returns a string from compTypes.h, identifying the type of component.
Reimplemented from DtAggregatedMovementActuator.
|
overridevirtual |
Sets the ordered altitude, in response to a set altitude command. If the ordered altitude is at or below the level of the terrain, then it is assumed that the intent is to land the entity, so SR->orderedAltitude is actually not set; instead, is-specified is set to false for orderedAltitude, and SR->amClampedToGround is set true. Otherwise, SR->amClampedToGround is set false.
Reimplemented from DtAggregatedMovementActuator.
|
static |
Creator function to be registered with the DtSimComponentFactory – see main.cxx.
|
overrideprotectedvirtual |
Returns an error string.
Reimplemented from DtAggregatedMovementActuator.
|
protected |
assignment operator - not implemented
|
overrideprotectedvirtual |
Override base function; do nothing.
Reimplemented from DtAggregatedMovementActuator.