DtSurfaceEntityActuatorDescriptor Class Reference

Contains class declaration for DtSurfaceEntityActuatorDescriptor, descriptor for the DtSurfaceEntityActuator component.

A DtActuatorComponentDescriptor that has additional information needed for providing parameters to the kinematics-based ship model.
Used to hold parameters for the DtSurfaceEntityActuator class.

Inheritance diagram for DtSurfaceEntityActuatorDescriptor:

Public Member Functions
	DtSurfaceEntityActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtSurfaceEntityActuatorDescriptor (const DtSurfaceEntityActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSurfaceEntityActuatorDescriptor &	operator= (const DtSurfaceEntityActuatorDescriptor &orig)
virtual	~DtSurfaceEntityActuatorDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	maxYawRate () const
virtual void	setMaxYawRate (DtReal maxYawRate)
virtual DtReal	maxYawAcceleration () const
virtual void	setMaxYawAcceleration (DtReal maxYawAcceleration)
virtual bool	checkSoilType () const
virtual void	setCheckSoilType (bool check)
virtual double	stoppingSpeed () const
virtual void	setStoppingSpeed (DtReal stoppingSpeed)
virtual double	turnRollRate () const
virtual void	setTurnRollRate (DtReal rollRate)
virtual double	speedPitchRate () const
virtual void	setSpeedPitchRate (DtReal pitchRate)
virtual double	sinkingTime () const
virtual void	setSinkingTime (DtReal sinkingTime)
virtual bool	surfaceClampClutterEntities () const
virtual void	setSurfaceClampClutterEntities (bool clamp)
Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
virtual	~DtActuatorComponentDescriptor ()
virtual void	postGetSelf ()
virtual void	setDefaultArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
virtual const DtSimArtPartDescriptorList &	defaultArtPartDescriptorList () const
virtual DtSimArtPartDescriptorList &	defaultArtPartDescriptorList ()
virtual void	setArtPartTypes (const ArtPartTypeSet &partTypes)
virtual const ArtPartTypeSet &	artPartTypes () const
virtual DtArtPartType	firstArtPartType () const
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
virtual const DtString &	stateAndParameterDataPrefix () const
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () const
virtual void	setDebugActive (bool active)
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
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	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)

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtActuatorComponentDescriptor
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
	DtSurfaceEntityActuatorDescriptor ()
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwReal	mySinkingTime
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxYawAcceleration
DtRwReal	myMaxYawRate
DtRwBoolean	myCheckSoilType
DtRwBoolean	mySurfaceClampClutterEntities
DtRwReal	myStoppingSpeed
DtRwReal	myTurnRollRate
DtRwReal	mySpeedPitchRate
Protected Attributes inherited from DtActuatorComponentDescriptor
ArtPartTypeSet	myArtPartTypes
DtSimArtPartDescriptorList	myDefaultArtPartDescriptorList
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtActuatorComponentDescriptor
typedef std::set< DtArtPartType >	ArtPartTypeSet
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 )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtSurfaceEntityActuatorDescriptor::DtSurfaceEntityActuatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

real constructor

DtSurfaceEntityActuatorDescriptor::DtSurfaceEntityActuatorDescriptor	(	const DtSurfaceEntityActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSurfaceEntityActuatorDescriptor::~DtSurfaceEntityActuatorDescriptor ( )

virtual

DtSurfaceEntityActuatorDescriptor::DtSurfaceEntityActuatorDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

static DtComponentDescriptor* DtSurfaceEntityActuatorDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

const DtSurfaceEntityActuatorDescriptor& DtSurfaceEntityActuatorDescriptor::operator=

(

const DtSurfaceEntityActuatorDescriptor &

orig

)

assignment

virtual DtString DtSurfaceEntityActuatorDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes. Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns

DtSurfaceEntityActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtSurfaceEntityActuatorDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtActuatorComponentDescriptor.

virtual DtReal DtSurfaceEntityActuatorDescriptor::maxYawRate ( ) const

virtual

Accessor/mutator for myMaxYawRate.

virtual void DtSurfaceEntityActuatorDescriptor::setMaxYawRate ( DtReal  maxYawRate )

virtual

Accessor/mutator for myMaxYawRate.

virtual DtReal DtSurfaceEntityActuatorDescriptor::maxYawAcceleration ( ) const

virtual

Accessor/mutator for myMaxYawAcceleration.

virtual void DtSurfaceEntityActuatorDescriptor::setMaxYawAcceleration ( DtReal  maxYawAcceleration )

virtual

Accessor/mutator for myMaxYawAcceleration.

virtual bool DtSurfaceEntityActuatorDescriptor::checkSoilType ( ) const

virtual

Accessor/mutator for myCheckSoilType.

virtual void DtSurfaceEntityActuatorDescriptor::setCheckSoilType ( bool  check )

virtual

Accessor/mutator for myCheckSoilType.

virtual double DtSurfaceEntityActuatorDescriptor::stoppingSpeed ( ) const

virtual

Accessor/mutator for myStoppingSpeed.

virtual void DtSurfaceEntityActuatorDescriptor::setStoppingSpeed ( DtReal  stoppingSpeed )

virtual

Accessor/mutator for myStoppingSpeed.

virtual double DtSurfaceEntityActuatorDescriptor::turnRollRate ( ) const

virtual

Accessor/mutator for myTurnRollRate.

virtual void DtSurfaceEntityActuatorDescriptor::setTurnRollRate ( DtReal  rollRate )

virtual

Accessor/mutator for myTurnRollRate.

virtual double DtSurfaceEntityActuatorDescriptor::speedPitchRate ( ) const

virtual

Accessor/mutator for mySpeedPitchRate.

virtual void DtSurfaceEntityActuatorDescriptor::setSpeedPitchRate ( DtReal  pitchRate )

virtual

Accessor/mutator for mySpeedPitchRate.

virtual double DtSurfaceEntityActuatorDescriptor::sinkingTime ( ) const

virtual

Accessor/mutator for mySinkingTime;.

virtual void DtSurfaceEntityActuatorDescriptor::setSinkingTime ( DtReal  sinkingTime )

virtual

Accessor/mutator for mySinkingTime;.

virtual bool DtSurfaceEntityActuatorDescriptor::surfaceClampClutterEntities ( ) const

virtual

Accessor/mutator for mySurfaceClampClutterEntities;.

virtual void DtSurfaceEntityActuatorDescriptor::setSurfaceClampClutterEntities ( bool  clamp )

virtual

Accessor/mutator for mySurfaceClampClutterEntities;.

Member Data Documentation

DtRwReal DtSurfaceEntityActuatorDescriptor::myMaxYawAcceleration

protected

Parameter Name: max-yaw-acceleration
Parameter Description: This is the maximum rotational acceleration around the entity's body Z axis. (Not currently used.)
Parameter Default Value: 0.
Parameter Units: radians/second/second.

DtRwReal DtSurfaceEntityActuatorDescriptor::myMaxYawRate

protected

Parameter Name: max-yaw-rate
Parameter Description: The maximum rate at which the entity can rotate about its body Z axis.
Parameter Default Value: 1.0.
Parameter Units: radians/second.

DtRwBoolean DtSurfaceEntityActuatorDescriptor::myCheckSoilType

protected

Parameter Name: check-soil-type
Parameter Description: Specifies whether or not the surface entity should check to see if it is on a water soil type when moving. If true, it will not move when it is placed on a non-water polygon on the terrain.
Parameter Default Value: true
.

DtRwBoolean DtSurfaceEntityActuatorDescriptor::mySurfaceClampClutterEntities

protected

Parameter Name: surface-clamp-clutter-entities
Parameter Description: Specifies whether or not the surface entity should clamp itself to the surface of the water or just assume it is at 0 MSL for clutter entities.
Parameter Default Value: false
.

DtRwReal DtSurfaceEntityActuatorDescriptor::myStoppingSpeed

protected

Parameter Name: stopping-speed
Parameter Description:Returns the speed used by clampSmallVelocityToZero() to determine when to stop drifting ships. The default value is 1.0.
Parameter Default Value: 1.0
.

DtRwReal DtSurfaceEntityActuatorDescriptor::myTurnRollRate

protected

Parameter Name: turn-roll-rate
Parameter Description: Indicates the number of radians of roll outward the entity undergoes per m/s^2 of lateral acceleration inward. This is used for appearances only; it doesn't affect speed or turn radius.
Parameter Default Value: 0.2
Parameter Units: radians/(m/s^2)
.

DtRwReal DtSurfaceEntityActuatorDescriptor::mySpeedPitchRate

protected

Parameter Name: speed-pitch-rate
Parameter Description: Indicates the number of radians of pitch up the entity undergoes per m/s of forward speed. There is no effect from backward speed. This is used for appearances only; it doesn't affect speed. The entity is rotated from a point 20% of the way from the stern to the bow, so the front end is lifted more and the back end sinks less.
Parameter Default Value: 0.015
Parameter Units: radians/(m/s)
.

DtRwReal DtSurfaceEntityActuatorDescriptor::mySinkingTime

protected

Parameter Name: sinking-time
Parameter Description: Gives the (maximum) amount of time that it will take for a ship to sink completely below the surface. That is, it's origin will be <length> below the surface. If this parameter is 0 (default), then the sinking time will be determined by other factors–it will be proportional to the length of the ship, and may have some random component as well.
Parameter Default Value: 0.0
Parameter Units: seconds
.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/surfaceEntityActuatorDescriptor.h