DtRwArtPartState Class Reference

A readable, writable type that holds an articulated part state.

Inheritance diagram for DtRwArtPartState:

Public Types
enum	MergeRule { AllSpecifiedValues, OnlyIfMyValueIsUnspecified, AllSpecifiedValuesExceptRates }
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
	DtRwArtPartState ()
	DtRwArtPartState (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwArtPartState (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwArtPartState (const DtRwArtPartState &orig, const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRwArtPartState (const DtRwArtPartState &orig, const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
const DtRwArtPartState &	operator= (const DtRwArtPartState &orig)
virtual	~DtRwArtPartState () override
virtual DtRwArtPartState *	clone (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtRwArtPartState *	clone (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	mergeSpecifiedParameters (const DtRwArtPartState &other, MergeRule rule=AllSpecifiedValues)
virtual void	markMatchingFieldsUnspecified (const DtRwArtPartState &other)
virtual bool	fullAzimuthRotation () const
bool	operator== (const DtRwArtPartState &rhs) const
bool	operator!= (const DtRwArtPartState &rhs) const
virtual void	setAttachPoint (const DtVector &attachPoint, bool isSpecified=true)
virtual DtVector	attachPoint () const
virtual bool	attachPointSpecified () const
virtual DtVector	endPoint () const
virtual void	setEndPoint (const DtVector &loc, bool isSpecified=true)
virtual bool	endPointSpecified () const
virtual double	position () const
virtual void	setPosition (double val, bool isSpecified=true)
virtual bool	positionSpecified () const
virtual double	positionRate () const
virtual void	setPositionRate (double val, bool isSpecified=true)
virtual bool	positionRateSpecified () const
virtual double	maxPositionRate () const
virtual void	setMaxPositionRate (double val, bool isSpecified=true)
virtual bool	maxPositionRateSpecified () const
virtual double	extension () const
virtual void	setExtension (double val, bool isSpecified=true)
virtual bool	extensionSpecified () const
virtual double	maxExtension () const
virtual void	setMaxExtension (double val, bool isSpecified=true)
virtual bool	maxExtensionSpecified () const
virtual double	extensionRate () const
virtual void	setExtensionRate (double val, bool isSpecified=true)
virtual bool	extensionRateSpecified () const
virtual double	maxExtensionRate () const
virtual void	setMaxExtensionRate (double val, bool isSpecified=true)
virtual bool	maxExtensionRateSpecified () const
virtual DtVector	translation () const
virtual void	setTranslation (const DtVector &val, bool isSpecified=true)
virtual bool	translationSpecified () const
virtual DtVector	minTranslation () const
virtual void	setMinTranslation (const DtVector &val, bool isSpecified=true)
virtual bool	minTranslationSpecified () const
virtual DtVector	maxTranslation () const
virtual void	setMaxTranslation (const DtVector &val, bool isSpecified=true)
virtual bool	maxTranslationSpecified () const
virtual DtVector	translationRate () const
virtual void	setTranslationRate (const DtVector &val, bool isSpecified=true)
virtual bool	translationRateSpecified () const
virtual DtVector	maxTranslationRate () const
virtual void	setMaxTranslationRate (const DtVector &val, bool isSpecified=true)
virtual bool	maxTranslationRateSpecified () const
virtual double	azimuth () const
virtual void	setAzimuth (double angle, bool isSpecified=true)
virtual bool	azimuthSpecified () const
virtual double	minAzimuth () const
virtual void	setMinAzimuth (double angle, bool isSpecified=true)
virtual bool	minAzimuthSpecified () const
virtual double	maxAzimuth () const
virtual void	setMaxAzimuth (double angle, bool isSpecified=true)
virtual bool	maxAzimuthSpecified () const
virtual double	azimuthRate () const
virtual void	setAzimuthRate (double rate, bool isSpecified=true)
virtual bool	azimuthRateSpecified () const
virtual double	maxAzimuthRate () const
virtual void	setMaxAzimuthRate (double rate, bool isSpecified=true)
virtual bool	maxAzimuthRateSpecified () const
virtual double	elevation () const
virtual void	setElevation (double angle, bool isSpecified=true)
virtual bool	elevationSpecified () const
virtual double	minElevation () const
virtual void	setMinElevation (double angle, bool isSpecified=true)
virtual bool	minElevationSpecified () const
virtual double	maxElevation () const
virtual void	setMaxElevation (double angle, bool isSpecified=true)
virtual bool	maxElevationSpecified () const
virtual double	elevationRate () const
virtual void	setElevationRate (double rate, bool isSpecified=true)
virtual bool	elevationRateSpecified () const
virtual double	maxElevationRate () const
virtual void	setMaxElevationRate (double rate, bool isSpecified=true)
virtual bool	maxElevationRateSpecified () const
virtual double	rotation () const
virtual void	setRotation (double angle, bool isSpecified=true)
virtual bool	rotationSpecified () const
virtual double	minRotation () const
virtual void	setMinRotation (double angle, bool isSpecified=true)
virtual bool	minRotationSpecified () const
virtual double	maxRotation () const
virtual void	setMaxRotation (double angle, bool isSpecified=true)
virtual bool	maxRotationSpecified () const
virtual double	rotationRate () const
virtual void	setRotationRate (double rate, bool isSpecified=true)
virtual bool	rotationRateSpecified () const
virtual double	maxRotationRate () const
virtual void	setMaxRotationRate (double rate, bool isSpecified=true)
virtual bool	maxRotationRateSpecified () const
virtual const DtString &	associatedComponent () const
virtual void	setAssociatedComponent (const DtString &component, bool isSpecified=true)
virtual bool	associatedComponentSpecified () const
virtual const DtString &	comment () const
virtual void	setComment (const DtString &component, bool isSpecified=true)
virtual bool	commentSpecified () const
virtual const std::set < DtString > &	configSources () const
virtual void	setConfigSources (const std::set< DtString > &srcs)
virtual void	addConfigSource (const DtString &src)
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	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 double	defaultRotationRate ()
static void	setDefaultRotationRate (double rate)
static double	defaultTranslationRate ()
static void	setDefaultTranslationRate (double rate)
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 Attributes
std::set< DtString >	myConfigSources
parameters
These parameters are available for setting in the OPD files.
DtRwOffsetVector	myAttachPoint
DtRwOffsetVector	myEndPoint
DtRwVector	myTranslation
DtRwVector	myMinTranslation
DtRwVector	myMaxTranslation
DtRwVector	myTranslationRate
DtRwVector	myMaxTranslationRate
DtRwReal	myPosition
DtRwReal	myPositionRate
DtRwReal	myMaxPositionRate
DtRwReal	myExtension
DtRwReal	myMaxExtension
DtRwReal	myExtensionRate
DtRwReal	myMaxExtensionRate
DtRwReal	myAzimuth
DtRwReal	myMinAzimuth
DtRwReal	myMaxAzimuth
DtRwReal	myAzimuthRate
DtRwReal	myMaxAzimuthRate
DtRwReal	myElevation
DtRwReal	myMinElevation
DtRwReal	myMaxElevation
DtRwReal	myElevationRate
DtRwReal	myMaxElevationRate
DtRwReal	myRotation
DtRwReal	myMinRotation
DtRwReal	myMaxRotation
DtRwReal	myRotationRate
DtRwReal	myMaxRotationRate
DtRwString	myAssociatedComponent
DtRwString	myComment
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

Static Protected Attributes
static double	theDefaultRotationRate
static double	theDefaultTranslationRate
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

Additional Inherited Members
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Member Enumeration Documentation

enum DtRwArtPartState::MergeRule

Enumerator
AllSpecifiedValues
OnlyIfMyValueIsUnspecified	Takes all specified values in other state.
AllSpecifiedValuesExceptRates	Takes only specified values for those settings where my current value is unspecified. Takes all specified values except for rates, which will only be taken if our own rate is unspecified.

Constructor & Destructor Documentation

DtRwArtPartState::DtRwArtPartState

(

)

Default constructor.

DtRwArtPartState::DtRwArtPartState	(	const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor.

DtRwArtPartState::DtRwArtPartState	(	const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Constructor.

DtRwArtPartState::DtRwArtPartState	(	const DtRwArtPartState &	orig,
		const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Copy constructor.

DtRwArtPartState::DtRwArtPartState	(	const DtRwArtPartState &	orig,
		const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Copy constructor.

virtual DtRwArtPartState::~DtRwArtPartState ( )

overridevirtual

Member Function Documentation

const DtRwArtPartState& DtRwArtPartState::operator=

(

const DtRwArtPartState &

orig

)

assignment

virtual DtRwArtPartState* DtRwArtPartState::clone ( const DtString &  partName, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

Reimplemented in DtSimArtPartDescriptor.

virtual DtRwArtPartState* DtRwArtPartState::clone ( const DtSymbolString &  partName, DtReaderWriterRegistry *  parentRegistry = NULL  ) const

virtual

Reimplemented in DtSimArtPartDescriptor.

virtual bool DtRwArtPartState::mergeSpecifiedParameters ( const DtRwArtPartState &  other, MergeRule  rule = AllSpecifiedValues  )

virtual

Sets local parameter values to that of the other part, as long as the other part has that parameter set. Returns true if any parameters were updated.

virtual void DtRwArtPartState::markMatchingFieldsUnspecified ( const DtRwArtPartState &  other )

virtual

Sets all values that match the other part state to unspecified.

virtual void DtRwArtPartState::setAttachPoint ( const DtVector &  attachPoint, bool  isSpecified = true  )

virtual

Accessor/mutator for myAttachPoint.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual DtVector DtRwArtPartState::attachPoint ( ) const

virtual

Accessor/mutator for myAttachPoint.

virtual bool DtRwArtPartState::attachPointSpecified ( ) const

virtual

Accessor/mutator for myAttachPoint.

virtual DtVector DtRwArtPartState::endPoint ( ) const

virtual

Accessor/mutator for myEndPoint.

virtual void DtRwArtPartState::setEndPoint ( const DtVector &  loc, bool  isSpecified = true  )

virtual

Accessor/mutator for myEndPoint.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::endPointSpecified ( ) const

virtual

Accessor/mutator for myEndPoint.

virtual double DtRwArtPartState::position ( ) const

virtual

Accessor/mutator for myPosition.

virtual void DtRwArtPartState::setPosition ( double  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myPosition.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::positionSpecified ( ) const

virtual

Accessor/mutator for myPosition.

virtual double DtRwArtPartState::positionRate ( ) const

virtual

Accessor/mutator for myPositionRate.

virtual void DtRwArtPartState::setPositionRate ( double  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myPositionRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::positionRateSpecified ( ) const

virtual

Accessor/mutator for myPositionRate.

virtual double DtRwArtPartState::maxPositionRate ( ) const

virtual

Accessor/mutator for myMaxPositionRate.

virtual void DtRwArtPartState::setMaxPositionRate ( double  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxPositionRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxPositionRateSpecified ( ) const

virtual

Accessor/mutator for myMaxPositionRate.

virtual double DtRwArtPartState::extension ( ) const

virtual

Accessor/mutator for myExtension.

virtual void DtRwArtPartState::setExtension ( double  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myExtension.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::extensionSpecified ( ) const

virtual

Accessor/mutator for myExtension.

virtual double DtRwArtPartState::maxExtension ( ) const

virtual

Accessor/mutator for myMaxExtension.

virtual void DtRwArtPartState::setMaxExtension ( double  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxExtension.

virtual bool DtRwArtPartState::maxExtensionSpecified ( ) const

virtual

Accessor/mutator for myMaxExtension.

virtual double DtRwArtPartState::extensionRate ( ) const

virtual

Accessor/mutator for myExtensionRate.

virtual void DtRwArtPartState::setExtensionRate ( double  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myExtensionRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::extensionRateSpecified ( ) const

virtual

Accessor/mutator for myExtensionRate.

virtual double DtRwArtPartState::maxExtensionRate ( ) const

virtual

Accessor/mutator for myMaxExtensionRate.

virtual void DtRwArtPartState::setMaxExtensionRate ( double  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxExtensionRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxExtensionRateSpecified ( ) const

virtual

Accessor/mutator for myMaxExtensionRate.

virtual DtVector DtRwArtPartState::translation ( ) const

virtual

Accessor/mutator for myTranslation.

virtual void DtRwArtPartState::setTranslation ( const DtVector &  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myTranslation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::translationSpecified ( ) const

virtual

Accessor/mutator for myTranslation.

virtual DtVector DtRwArtPartState::minTranslation ( ) const

virtual

Accessor/mutator for myMinTranslation.

virtual void DtRwArtPartState::setMinTranslation ( const DtVector &  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myMinTranslation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::minTranslationSpecified ( ) const

virtual

Accessor/mutator for myMinTranslation.

virtual DtVector DtRwArtPartState::maxTranslation ( ) const

virtual

Accessor/mutator for myMaxTranslation.

virtual void DtRwArtPartState::setMaxTranslation ( const DtVector &  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxTranslation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxTranslationSpecified ( ) const

virtual

Accessor/mutator for myMaxTranslation.

virtual DtVector DtRwArtPartState::translationRate ( ) const

virtual

Accessor/mutator for myTranslationRate.

virtual void DtRwArtPartState::setTranslationRate ( const DtVector &  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myTranslationRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::translationRateSpecified ( ) const

virtual

Accessor/mutator for myTranslationRate.

virtual DtVector DtRwArtPartState::maxTranslationRate ( ) const

virtual

Accessor/mutator for myMaxTranslationRate.

virtual void DtRwArtPartState::setMaxTranslationRate ( const DtVector &  val, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxTranslationRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxTranslationRateSpecified ( ) const

virtual

Accessor/mutator for myMaxTranslationRate.

virtual double DtRwArtPartState::azimuth ( ) const

virtual

Accessor/mutator for myAzimuth.

virtual void DtRwArtPartState::setAzimuth ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myAzimuth.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::azimuthSpecified ( ) const

virtual

Accessor/mutator for myAzimuth.

virtual double DtRwArtPartState::minAzimuth ( ) const

virtual

Accessor/mutator for myMinAzimuth.

virtual void DtRwArtPartState::setMinAzimuth ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myMinAzimuth.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::minAzimuthSpecified ( ) const

virtual

Accessor/mutator for myMinAzimuth.

virtual double DtRwArtPartState::maxAzimuth ( ) const

virtual

Accessor/mutator for myMaxAzimuth.

virtual void DtRwArtPartState::setMaxAzimuth ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxAzimuth.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxAzimuthSpecified ( ) const

virtual

Accessor/mutator for myMaxAzimuth.

virtual double DtRwArtPartState::azimuthRate ( ) const

virtual

Accessor/mutator for myAzimuthRate.

virtual void DtRwArtPartState::setAzimuthRate ( double  rate, bool  isSpecified = true  )

virtual

Accessor/mutator for myAzimuthRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::azimuthRateSpecified ( ) const

virtual

Accessor/mutator for myAzimuthRate.

virtual double DtRwArtPartState::maxAzimuthRate ( ) const

virtual

Accessor/mutator for myMaxAzimuthRate.

virtual void DtRwArtPartState::setMaxAzimuthRate ( double  rate, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxAzimuthRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxAzimuthRateSpecified ( ) const

virtual

Accessor/mutator for myMaxAzimuthRate.

virtual bool DtRwArtPartState::fullAzimuthRotation ( ) const

virtual

Returns true if the part can perform a full azimuth rotation.

virtual double DtRwArtPartState::elevation ( ) const

virtual

Accessor/mutator for myElevation.

virtual void DtRwArtPartState::setElevation ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myElevation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::elevationSpecified ( ) const

virtual

Accessor/mutator for myElevation.

virtual double DtRwArtPartState::minElevation ( ) const

virtual

Accessor/mutator for myMinElevation.

virtual void DtRwArtPartState::setMinElevation ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myMinElevation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::minElevationSpecified ( ) const

virtual

Accessor/mutator for myMinElevation.

virtual double DtRwArtPartState::maxElevation ( ) const

virtual

Accessor/mutator for myMaxElevation.

virtual void DtRwArtPartState::setMaxElevation ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxElevation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxElevationSpecified ( ) const

virtual

Accessor/mutator for myMaxElevation.

virtual double DtRwArtPartState::elevationRate ( ) const

virtual

Accessor/mutator for myElevationRate.

virtual void DtRwArtPartState::setElevationRate ( double  rate, bool  isSpecified = true  )

virtual

Accessor/mutator for myElevationRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::elevationRateSpecified ( ) const

virtual

Accessor/mutator for myElevationRate.

virtual double DtRwArtPartState::maxElevationRate ( ) const

virtual

Accessor/mutator for myMaxElevationRate.

virtual void DtRwArtPartState::setMaxElevationRate ( double  rate, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxElevationRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxElevationRateSpecified ( ) const

virtual

Accessor/mutator for myMaxElevationRate.

virtual double DtRwArtPartState::rotation ( ) const

virtual

Accessor/mutator for myRotation.

virtual void DtRwArtPartState::setRotation ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myRotation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::rotationSpecified ( ) const

virtual

Accessor/mutator for myRotation.

virtual double DtRwArtPartState::minRotation ( ) const

virtual

Accessor/mutator for myMinRotation.

virtual void DtRwArtPartState::setMinRotation ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myMinRotation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::minRotationSpecified ( ) const

virtual

Accessor/mutator for myMinRotation.

virtual double DtRwArtPartState::maxRotation ( ) const

virtual

Accessor/mutator for myRotation.

virtual void DtRwArtPartState::setMaxRotation ( double  angle, bool  isSpecified = true  )

virtual

Accessor/mutator for myRotation.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxRotationSpecified ( ) const

virtual

Accessor/mutator for myRotation.

virtual double DtRwArtPartState::rotationRate ( ) const

virtual

Accessor/mutator for myRotationRate.

virtual void DtRwArtPartState::setRotationRate ( double  rate, bool  isSpecified = true  )

virtual

Accessor/mutator for myRotationRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::rotationRateSpecified ( ) const

virtual

Accessor/mutator for myRotationRate.

virtual double DtRwArtPartState::maxRotationRate ( ) const

virtual

Accessor/mutator for myMaxRotationRate.

virtual void DtRwArtPartState::setMaxRotationRate ( double  rate, bool  isSpecified = true  )

virtual

Accessor/mutator for myMaxRotationRate.

Reimplemented in makVrf::DtArticulatedPartStateRepository.

virtual bool DtRwArtPartState::maxRotationRateSpecified ( ) const

virtual

Accessor/mutator for myMaxRotationRate.

virtual const DtString& DtRwArtPartState::associatedComponent ( ) const

virtual

Accessor/mutator for myAssociatedComponent.

virtual void DtRwArtPartState::setAssociatedComponent ( const DtString &  component, bool  isSpecified = true  )

virtual

Accessor/mutator for myAssociatedComponent.

virtual bool DtRwArtPartState::associatedComponentSpecified ( ) const

virtual

Accessor/mutator for myAssociatedComponent.

virtual const DtString& DtRwArtPartState::comment ( ) const

virtual

Accessor/mutator for myComment.

virtual void DtRwArtPartState::setComment ( const DtString &  component, bool  isSpecified = true  )

virtual

Accessor/mutator for myComment.

virtual bool DtRwArtPartState::commentSpecified ( ) const

virtual

Accessor/mutator for myComment.

virtual const std::set<DtString>& DtRwArtPartState::configSources ( ) const

virtual

Accessor/mutator for #myConfigSource.

virtual void DtRwArtPartState::setConfigSources ( const std::set< DtString > &  srcs )

virtual

Accessor/mutator for #myConfigSource.

virtual void DtRwArtPartState::addConfigSource ( const DtString &  src )

virtual

Accessor/mutator for #myConfigSource.

bool DtRwArtPartState::operator==

(

const DtRwArtPartState &

rhs

)

const

bool DtRwArtPartState::operator!= ( const DtRwArtPartState &  rhs ) const

inline

static double DtRwArtPartState::defaultRotationRate ( )

static

The rotation rate to be used when a part is not configured with one, in radians/sec.

static void DtRwArtPartState::setDefaultRotationRate ( double  rate )

static

The rotation rate to be used when a part is not configured with one, in radians/sec.

static double DtRwArtPartState::defaultTranslationRate ( )

static

The rotation rate to be used when a part is not configured with one, in m/s.

static void DtRwArtPartState::setDefaultTranslationRate ( double  rate )

static

The rotation rate to be used when a part is not configured with one, in m/s.

Member Data Documentation

DtRwOffsetVector DtRwArtPartState::myAttachPoint

protected

Parameter Name: attach-point Parameter Description: The point at which at the articulated or attached part is attached to another object. If this part is being attached to an entity, then the attach-point is is specified in the body coordinate system of the entity. If part is being attached to another attached or articulated part, then the attach-point is specified in the body coordinate system of the part it is being attached to. In a body coordinate system, the axes are specified as follows:
.

• x-axis points out of the 'front' of the object
  
• y-axis points out of the 'side' of the object
  
• z-axis points out of the 'bottom' of the object Parameter Default Value: (0. 0. 0.) Parameter Units: meters

DtRwOffsetVector DtRwArtPartState::myEndPoint

protected

Parameter Name: end-point Parameter Description: The point at which at the articulated or attached part ends. This value is relative the part itself, offset from the attach point. Can be used to determine things such as muzzle position on a gun. Parameter Default Value: (0. 0. 0.) Parameter Units: meters.

DtRwVector DtRwArtPartState::myTranslation

protected

Parameter Name: translation Parameter Description: The current part translation value. Parameter Default Value: (0. 0. 0.) Parameter Units: meters.

DtRwVector DtRwArtPartState::myMinTranslation

protected

Parameter Name: min-translation Parameter Description: The minimum part translation value. Parameter Default Value: (-max dbl -max dbl -max dbl) Parameter Units: meters.

DtRwVector DtRwArtPartState::myMaxTranslation

protected

Parameter Name: max-translation Parameter Description: The maximum part translation value. Parameter Default Value: (max dbl max dbl max dbl) Parameter Units: meters.

DtRwVector DtRwArtPartState::myTranslationRate

protected

Parameter Name: translation-rate Parameter Description: The current translation rate. Parameter Default Value: (0. 0. 0.) Parameter Units: meters/sec.

DtRwVector DtRwArtPartState::myMaxTranslationRate

protected

Parameter Name: translation-rate Parameter Description: The maximum translation rate. Parameter Default Value: (max dbl max dbl max dbl) Parameter Units: meters/sec.

DtRwReal DtRwArtPartState::myPosition

protected

Parameter Name: position Parameter Description: The current position of the part along a set path where 0 is fully retracted and 1 is fully extended. Parameter Default Value: 0 Parameter Units: n/a.

DtRwReal DtRwArtPartState::myPositionRate

protected

Parameter Name: position-rate Parameter Description: The current rate of change of the position of the part along a set path. Parameter Default Value: 0 Parameter Units: position change per second.

DtRwReal DtRwArtPartState::myMaxPositionRate

protected

Parameter Name: position-rate Parameter Description: The maximum rate of change of the position of the part along a set path. Parameter Default Value: 0 Parameter Units: position change per second.

DtRwReal DtRwArtPartState::myExtension

protected

Parameter Name: extension Parameter Description: The linear extension of the part in a single direction. Parameter Default Value: 0 (fully retracted) Parameter Units: meters.

DtRwReal DtRwArtPartState::myMaxExtension

protected

Parameter Name: max-extension Parameter Description: The maximum linear extension of the part in a single direction. Parameter Default Value: 0 (fully retracted) Parameter Units: meters.

DtRwReal DtRwArtPartState::myExtensionRate

protected

Parameter Name: extension-rate Parameter Description: The rate of change of the linear extension of the part in a single direction. Parameter Default Value: 0 Parameter Units: meters/sec.

DtRwReal DtRwArtPartState::myMaxExtensionRate

protected

Parameter Name: max-extension-rate Parameter Description: The maximum rate of change of the linear extension of the part in a single direction. Parameter Default Value: 0 Parameter Units: meters/sec.

DtRwReal DtRwArtPartState::myAzimuth

protected

Parameter Name: azimuth Parameter Description: The current or default azimuth. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myMinAzimuth

protected

Parameter Name: min-azimuth Parameter Description: The minimum azimuth value. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myMaxAzimuth

protected

Parameter Name: max-azimuth Parameter Description: The maximum azimuth value. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myAzimuthRate

protected

Parameter Name: azimuth-rate Parameter Description: The current azimuth rate of change. Parameter Default Value: 0.0 Parameter Units: radians/sec.

DtRwReal DtRwArtPartState::myMaxAzimuthRate

protected

Parameter Name: max-azimuth-rate Parameter Description: The maximum azimuth rate of change. Parameter Default Value: 0.0 Parameter Units: radians/sec.

DtRwReal DtRwArtPartState::myElevation

protected

Parameter Name: elevation Parameter Description: The current or default elevation. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myMinElevation

protected

Parameter Name: min-elevation Parameter Description: The minimum elevation value. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myMaxElevation

protected

Parameter Name: max-elevation Parameter Description: The maximum elevation value. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myElevationRate

protected

Parameter Name: elevation-rate Parameter Description: The current elevation rate of change. Parameter Default Value: 0.0 Parameter Units: radians/sec.

DtRwReal DtRwArtPartState::myMaxElevationRate

protected

Parameter Name: max-elevation-rate Parameter Description: The maximum elevation rate of change. Parameter Default Value: 0.0 Parameter Units: radians/sec.

DtRwReal DtRwArtPartState::myRotation

protected

Parameter Name: rotation Parameter Description: The current or default rotation. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myMinRotation

protected

Parameter Name: min-rotation Parameter Description: The minimum rotation value. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myMaxRotation

protected

Parameter Name: max-rotation Parameter Description: The maximum rotation value. Parameter Default Value: 0.0 Parameter Units: radians.

DtRwReal DtRwArtPartState::myRotationRate

protected

Parameter Name: rotation-rate Parameter Description: The maximum rotation rate of change. Parameter Default Value: 0.0 Parameter Units: radians/sec.

DtRwReal DtRwArtPartState::myMaxRotationRate

protected

Parameter Name: max-rotation-rate Parameter Description: The maximum rotation rate of change. Parameter Default Value: 0.0 Parameter Units: radians/sec.

DtRwString DtRwArtPartState::myAssociatedComponent

protected

Parameter Name: associated-component Parameter Description: The name of the associated component. Empty string if no associated component. Parameter Default Value: "" Parameter Units: n/a.

DtRwString DtRwArtPartState::myComment

protected

Parameter Name: comment Parameter Description: A comment a user can optionally save with the articulated part. Parameter Default Value: "" Parameter Units: n/a.

std::set<DtString> DtRwArtPartState::myConfigSources

protected

double DtRwArtPartState::theDefaultRotationRate

staticprotected

double DtRwArtPartState::theDefaultTranslationRate

staticprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/rwArtPartState.h