DtSurfaceEntityActuatorDescriptor Class Reference

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

Inheritance diagram for DtSurfaceEntityActuatorDescriptor:

Public Member Functions
	DtSurfaceEntityActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtSurfaceEntityActuatorDescriptor (const DtSurfaceEntityActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSurfaceEntityActuatorDescriptor &	operator= (const DtSurfaceEntityActuatorDescriptor &orig)
	assignment
virtual	~DtSurfaceEntityActuatorDescriptor ()
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	maxYawRate () const
	Accessor/mutator for myMaxYawRate.
virtual void	setMaxYawRate (DtReal maxYawRate)
virtual DtReal	maxYawAcceleration () const
	Accessor/mutator for myMaxYawAcceleration.
virtual void	setMaxYawAcceleration (DtReal maxYawAcceleration)
virtual bool	checkSoilType () const
	Accessor/mutator for myCheckSoilType.
virtual void	setCheckSoilType (bool check)
virtual double	stoppingSpeed () const
	Accessor/mutator for myStoppingSpeed.
virtual void	setStoppingSpeed (DtReal stoppingSpeed)
virtual double	turnRollRate () const
	Accessor/mutator for myTurnRollRate.
virtual void	setTurnRollRate (DtReal rollRate)
virtual double	speedPitchRate () const
	Accessor/mutator for mySpeedPitchRate.
virtual void	setSpeedPitchRate (DtReal pitchRate)
virtual double	sinkingTime () const
	Accessor/mutator for mySinkingTime;.
virtual void	setSinkingTime (DtReal sinkingTime)
Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
	assignment
virtual	~DtActuatorComponentDescriptor ()
	destructor
virtual void	setArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
	Accessor/mutator for myArtPartDescriptorList.
virtual const DtSimArtPartDescriptorList &	artPartDescriptorList () const
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type.
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 actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
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)
	Type of DtSimComponent this descriptor is associated with.
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	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
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)
	Should the component be created or not.
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object.
virtual bool	createOnRemoteObject () 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 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 (std::string &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 (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original 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 char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () 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 bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
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 &)
	Restores 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 DtComponentDescriptor *	creator ()

Protected Member Functions
	DtSurfaceEntityActuatorDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.

Protected Attributes
DtRwReal	mySinkingTime
	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.
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxYawAcceleration
	Parameter Name: max-yaw-acceleration Parameter Description: This is the maximum rotational acceleration around the entity's body Z axis.
DtRwReal	myMaxYawRate
	Parameter Name: max-yaw-rate Parameter Description: The maximum rate at which the entity can rotate about its body Z axis.
DtRwBoolean	myCheckSoilType
	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.
DtRwReal	myStoppingSpeed
	Parameter Name: stopping-speed Parameter Description:Returns the speed used by clampSmallVelocityToZero() to determine when to stop drifting ships.
DtRwReal	myTurnRollRate
	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.
DtRwReal	mySpeedPitchRate
	Parameter Name: speed-pitch-rate Parameter Description: Indicates the number of radians of pitch up the entity undergoes per m/s of forward speed.
Protected Attributes inherited from DtActuatorComponentDescriptor
DtSimArtPartDescriptorList	myArtPartDescriptorList
	Parameter Name: art-part-list Parameter Description: List of articulated parts associated with this actuator.
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component.
DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not.
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations.
DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled.
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 )()
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

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.

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.

Reimplemented from DtActuatorComponentDescriptor.

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

virtual DtReal DtSurfaceEntityActuatorDescriptor::maxYawAcceleration ( ) const

virtual

Accessor/mutator for myMaxYawAcceleration.

virtual void DtSurfaceEntityActuatorDescriptor::setMaxYawAcceleration ( DtReal  maxYawAcceleration )

virtual

virtual bool DtSurfaceEntityActuatorDescriptor::checkSoilType ( ) const

virtual

Accessor/mutator for myCheckSoilType.

virtual void DtSurfaceEntityActuatorDescriptor::setCheckSoilType ( bool  check )

virtual

virtual double DtSurfaceEntityActuatorDescriptor::stoppingSpeed ( ) const

virtual

Accessor/mutator for myStoppingSpeed.

virtual void DtSurfaceEntityActuatorDescriptor::setStoppingSpeed ( DtReal  stoppingSpeed )

virtual

virtual double DtSurfaceEntityActuatorDescriptor::turnRollRate ( ) const

virtual

Accessor/mutator for myTurnRollRate.

virtual void DtSurfaceEntityActuatorDescriptor::setTurnRollRate ( DtReal  rollRate )

virtual

virtual double DtSurfaceEntityActuatorDescriptor::speedPitchRate ( ) const

virtual

Accessor/mutator for mySpeedPitchRate.

virtual void DtSurfaceEntityActuatorDescriptor::setSpeedPitchRate ( DtReal  pitchRate )

virtual

virtual double DtSurfaceEntityActuatorDescriptor::sinkingTime ( ) const

virtual

Accessor/mutator for mySinkingTime;.

virtual void DtSurfaceEntityActuatorDescriptor::setSinkingTime ( DtReal  sinkingTime )

virtual

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.

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: 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

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/surfaceEntityActuatorDescriptor.h