DtActuatorComponentDescriptor Class Reference

End User Description: DtActuatorComponentDescriptor contains parameters common to all actuator component descriptors in VR-Forces.

Developer Description: DtActuatorComponentDescriptor is used to specify actuator components. It derives from DtComponentDescriptor. It adds a DtSimArtPartDescriptorList list of articulating parts that the actuator will model. The DtSimArtPartDescriptorList includes the information needed for VR-Link to represent articulated parts on the network. All actuators must use a DtActuatorComponentDescriptor, even if there are no articulating parts involved.

DtSimArtPartDescriptorList is a DtList of DtSimArtPartDescriptors. The DtSimArtPartDescriptor specifies a part type and a parent part type that are VR-Link articulated part types, a vector that represents where the articulating part is attached (in the parent part's coordinate system), and a DtSimArtPartParamList. The DtSimArtPartParamList is a DtList of the VR-Link articulated part parameter types the part should use. Enumerations for various types of articulated parts can be found in disEnums.h file. DtArtPartType is the type of articulated part that will be attached to the entity or another part like a turret or missile launcher. DtArtParamType describes the different types of parameters an articulated part has that will describe its motion. For example, a DtApAzimuth parameter will specify that the articulated part should rotate around the z axis of the part.

Inheritance diagram for DtActuatorComponentDescriptor:

Public Types
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 )()

Public Member Functions
	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 DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
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)
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 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
	DtActuatorComponentDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
ArtPartTypeSet	myArtPartTypes
parameters
These parameters are available for setting in the OPD files.
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
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

Member Typedef Documentation

typedef std::set<DtArtPartType> DtActuatorComponentDescriptor::ArtPartTypeSet

Constructor & Destructor Documentation

DtActuatorComponentDescriptor::DtActuatorComponentDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtActuatorComponentDescriptor::DtActuatorComponentDescriptor	(	const DtSymbolString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtActuatorComponentDescriptor::DtActuatorComponentDescriptor	(	const DtActuatorComponentDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtActuatorComponentDescriptor::~DtActuatorComponentDescriptor ( )

virtual

destructor

DtActuatorComponentDescriptor::DtActuatorComponentDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtActuatorComponentDescriptor& DtActuatorComponentDescriptor::operator=

(

const DtActuatorComponentDescriptor &

orig

)

assignment

virtual DtString DtActuatorComponentDescriptor::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

DtActuatorComponentDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtSwingingPartActuatorDescriptor, DtAggregatedMovementDescriptor, DtDamageAdjudicationComponentDescriptor, DtBallisticGunDescriptor, DtSurfaceEntityActuatorDescriptor, DtFixedWingActuatorDescriptor, DtLauncherActuatorDescriptor, DtTurretComponentDescriptor, DtAzimuthMountComponentDescriptor, DtElevationMountComponentDescriptor, DtRotaryWingActuatorDescriptor, DtParabolicTrajectoryActuatorDescriptor, DtTacticalSmokeActuatorDescriptor, DtTranslatablePartActuatorDescriptor, DtWarheadDetonationActuatorDescriptor, DtMultipleHitDamageActuatorDescriptor, DtSensorGimbalActuatorDescriptor, DtDieWhenHitDescriptor, DtHumanMovementActuatorDescriptor, DtTrailerActuatorDescriptor, DtVtolRotorActuatorDescriptor, DtAutomotiveActuatorDescriptor, DtWeaponActuatorDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtHumanDamageActuatorDescriptor, DtSuppressionActuatorDescriptor, DtEncumbranceActuatorDescriptor, DtHumanGunActuatorDescriptor, DtHumanWeaponStateActuatorDescriptor, DtLookAtActuatorDescriptor, DtNavMovementActuatorDescriptor, DtRotaryWingEncumberedFlightActuatorDescriptor, DtIndirectFireActuatorDescriptor, DtMissileLauncherActuatorDescriptor, DtExtendablePartActuatorDescriptor, DtSpawnObjectWarheadActuatorDescriptor, DtNonLethalDamageActuatorDescriptor, DtFallingFromSkyActuatorDescriptor, DtIndirectArtilleryDescriptor, DtParachuteActuatorDescriptor, and DtAirborneAggregatedMovementDescriptor.

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

virtual

Reimplemented from DtComponentDescriptor.

Reimplemented in DtSwingingPartActuatorDescriptor, DtDamageAdjudicationComponentDescriptor, DtAggregatedMovementDescriptor, DtBallisticGunDescriptor, DtVtolRotorActuatorDescriptor, DtDieWhenHitDescriptor, DtSurfaceEntityActuatorDescriptor, DtFixedWingActuatorDescriptor, DtAzimuthMountComponentDescriptor, DtLauncherActuatorDescriptor, DtTurretComponentDescriptor, DtElevationMountComponentDescriptor, DtRotaryWingActuatorDescriptor, DtParabolicTrajectoryActuatorDescriptor, DtTacticalSmokeActuatorDescriptor, DtWarheadDetonationActuatorDescriptor, DtMultipleHitDamageActuatorDescriptor, DtSensorGimbalActuatorDescriptor, DtHumanMovementActuatorDescriptor, DtTrailerActuatorDescriptor, DtAutomotiveActuatorDescriptor, DtTranslatablePartActuatorDescriptor, DtWeaponActuatorDescriptor, DtGlobalEnvironmentActuatorDescriptor, DtSuppressionActuatorDescriptor, DtEncumbranceActuatorDescriptor, DtHumanGunActuatorDescriptor, DtHumanWeaponStateActuatorDescriptor, DtLookAtActuatorDescriptor, DtNavMovementActuatorDescriptor, DtRotaryWingEncumberedFlightActuatorDescriptor, DtIndirectFireActuatorDescriptor, DtMissileLauncherActuatorDescriptor, DtSpawnObjectWarheadActuatorDescriptor, DtNonLethalDamageActuatorDescriptor, DtFallingFromSkyActuatorDescriptor, DtParachuteActuatorDescriptor, DtExtendablePartActuatorDescriptor, DtIndirectArtilleryDescriptor, DtHumanDamageActuatorDescriptor, and DtAirborneAggregatedMovementDescriptor.

virtual void DtActuatorComponentDescriptor::setDefaultArtPartDescriptorList ( const DtSimArtPartDescriptorList &  artPartDescriptorList )

virtual

Accessor/mutator for #myArtPartDescriptorList.

virtual const DtSimArtPartDescriptorList& DtActuatorComponentDescriptor::defaultArtPartDescriptorList ( ) const

virtual

Accessor/mutator for #myArtPartDescriptorList.

virtual DtSimArtPartDescriptorList& DtActuatorComponentDescriptor::defaultArtPartDescriptorList ( )

virtual

Accessor/mutator for #myArtPartDescriptorList.

virtual void DtActuatorComponentDescriptor::setArtPartTypes ( const ArtPartTypeSet &  partTypes )

virtual

Accessor/mutator for myArtPartTypes.

virtual const ArtPartTypeSet& DtActuatorComponentDescriptor::artPartTypes ( ) const

virtual

Accessor/mutator for myArtPartTypes.

virtual DtArtPartType DtActuatorComponentDescriptor::firstArtPartType ( ) const

virtual

Accessor/mutator for myArtPartTypes.

virtual void DtActuatorComponentDescriptor::postGetSelf ( )

virtual

Called after either version of getSelf (mtl or environment). Default is no-op.

Reimplemented from DtReaderWriter.

Reimplemented in DtMissileLauncherActuatorDescriptor.

static DtComponentDescriptor* DtActuatorComponentDescriptor::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.

Member Data Documentation

DtSimArtPartDescriptorList DtActuatorComponentDescriptor::myDefaultArtPartDescriptorList

protected

Parameter Name: default-art-part-list
Parameter Description: This parameter describes the default articulated part settings used by this actuator. When this actuator is added to an object in Simulation Object Editor, these parts will automatically be added to the object if not otherwise configured. Once added in the SOE, these settings can then be changed by the user. The final articulated part settings are saved on the entity, NOT in the actuator configuration. These default settings are ignored at runtime.
Parameter Default Value:
.

ArtPartTypeSet DtActuatorComponentDescriptor::myArtPartTypes

protected

List of configured articulated parts types associated with this actuator. Populated from myDefaultArtPartDescriptorList for fast lookup.

---

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

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