DtAggregatedMovementActuatorPSR Class Reference

Inheritance diagram for DtAggregatedMovementActuatorPSR:

Public Member Functions
	DtAggregatedMovementActuatorPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtAggregatedMovementActuatorPSR (const DtAggregatedMovementActuatorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtAggregatedMovementActuatorPSR ()
DtAggregatedMovementActuatorPSR &	operator= (const DtAggregatedMovementActuatorPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
virtual bool	haltMovementForObstacles () const
virtual void	setHaltMovementForObstacles (bool value)
virtual const DtString &	obstacleQueryName () const
virtual void	setObstacleQueryName (const DtString &objectTypes)
virtual bool	isHalted () const
virtual void	setIsHalted (bool value)
virtual DtSimObjectReference	blockingObstacle () const
virtual void	setBlockingObstacle (const DtUUID &obstacleName)
virtual DtTime	timeHalted () const
virtual void	setTimeHalted (DtTime timeHalted)
virtual const DtRwNLengthStringVector &	obstaclesToIgnore () const
virtual void	setObstaclesToIgnore (const DtRwNLengthStringVector &obstacleNames)
virtual void	addObstacleToIgnore (const DtString &obstacleName)
virtual void	removeObstacleToIgnore (const DtString &obstacleName)
virtual void	clearObstaclesToIgnore ()
virtual const DtRwNLengthStringVector &	unencounteredObstaclesToIgnore () const
virtual void	setUnencounteredObstaclesToIgnore (const DtRwNLengthStringVector &obstacleNames)
virtual void	addUnencounteredObstacleToIgnore (const DtString &obstacleName)
virtual void	removeUnencounteredObstacleToIgnore (const DtString &obstacleName)
virtual void	clearUnencounteredObstaclesToIgnore ()
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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	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	wasUpdatedSince (DtTime t) 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 DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
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
DtRwBoolean	myHaltMovementForObstacles
DtRwString	myObstacleQueryName
DtRwBoolean	myIsHalted
DtRwSimObjectReference	myBlockingObstacle
DtRwReal	myTimeHalted
DtRwNLengthStringVector	myObstaclesToIgnore
DtRwNLengthStringVector	myUnencounteredObstaclesToIgnore
Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject
bool	myLoadedFromMTL
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 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 )()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
const DtSimObject *	vrfObject () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory
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

DtAggregatedMovementActuatorPSR::DtAggregatedMovementActuatorPSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtAggregatedMovementActuatorPSR::DtAggregatedMovementActuatorPSR	(	const DtAggregatedMovementActuatorPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtAggregatedMovementActuatorPSR::~DtAggregatedMovementActuatorPSR ( )

virtual

destructor

Member Function Documentation

DtAggregatedMovementActuatorPSR& DtAggregatedMovementActuatorPSR::operator=

(

const DtAggregatedMovementActuatorPSR &

orig

)

assignment operator - not implemented

virtual DtVrfProcessStateRepository* DtAggregatedMovementActuatorPSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtAggregatedMovementActuatorPSR::type ( ) const

virtual

Returns the string type of the repository, as defined in procSRTypes.h.

Implements DtVrfProcessStateRepository.

virtual bool DtAggregatedMovementActuatorPSR::haltMovementForObstacles ( ) const

virtual

Accessor/Mutator for myHaltMovementForObstacles.

virtual void DtAggregatedMovementActuatorPSR::setHaltMovementForObstacles ( bool  value )

virtual

Accessor/Mutator for myHaltMovementForObstacles.

virtual const DtString& DtAggregatedMovementActuatorPSR::obstacleQueryName ( ) const

virtual

Accessor/Mutator for #myRequestedState.

virtual void DtAggregatedMovementActuatorPSR::setObstacleQueryName ( const DtString &  objectTypes )

virtual

Accessor/Mutator for #myRequestedState.

virtual bool DtAggregatedMovementActuatorPSR::isHalted ( ) const

virtual

Accessor/Mutator for myIsHalted.

virtual void DtAggregatedMovementActuatorPSR::setIsHalted ( bool  value )

virtual

Accessor/Mutator for myIsHalted.

virtual DtSimObjectReference DtAggregatedMovementActuatorPSR::blockingObstacle ( ) const

virtual

Accessor/Mutator for myBlockingObstacle.

virtual void DtAggregatedMovementActuatorPSR::setBlockingObstacle ( const DtUUID &  obstacleName )

virtual

Accessor/Mutator for myBlockingObstacle.

virtual DtTime DtAggregatedMovementActuatorPSR::timeHalted ( ) const

virtual

Accessor/Mutator for myBlockingObstacle.

virtual void DtAggregatedMovementActuatorPSR::setTimeHalted ( DtTime  timeHalted )

virtual

Accessor/Mutator for myBlockingObstacle.

virtual const DtRwNLengthStringVector& DtAggregatedMovementActuatorPSR::obstaclesToIgnore ( ) const

virtual

Accessor/Mutators for myObstaclesToIgnore.

virtual void DtAggregatedMovementActuatorPSR::setObstaclesToIgnore ( const DtRwNLengthStringVector &  obstacleNames )

virtual

Accessor/Mutators for myObstaclesToIgnore.

virtual void DtAggregatedMovementActuatorPSR::addObstacleToIgnore ( const DtString &  obstacleName )

virtual

Accessor/Mutators for myObstaclesToIgnore.

virtual void DtAggregatedMovementActuatorPSR::removeObstacleToIgnore ( const DtString &  obstacleName )

virtual

Accessor/Mutators for myObstaclesToIgnore.

virtual void DtAggregatedMovementActuatorPSR::clearObstaclesToIgnore ( )

virtual

Accessor/Mutators for myObstaclesToIgnore.

virtual const DtRwNLengthStringVector& DtAggregatedMovementActuatorPSR::unencounteredObstaclesToIgnore ( ) const

virtual

Accessor/Mutators for myUnencounteredObstaclesToIgnore.

virtual void DtAggregatedMovementActuatorPSR::setUnencounteredObstaclesToIgnore ( const DtRwNLengthStringVector &  obstacleNames )

virtual

Accessor/Mutators for myUnencounteredObstaclesToIgnore.

virtual void DtAggregatedMovementActuatorPSR::addUnencounteredObstacleToIgnore ( const DtString &  obstacleName )

virtual

Accessor/Mutators for myUnencounteredObstaclesToIgnore.

virtual void DtAggregatedMovementActuatorPSR::removeUnencounteredObstacleToIgnore ( const DtString &  obstacleName )

virtual

Accessor/Mutators for myUnencounteredObstaclesToIgnore.

virtual void DtAggregatedMovementActuatorPSR::clearUnencounteredObstaclesToIgnore ( )

virtual

Accessor/Mutators for myUnencounteredObstaclesToIgnore.

static DtVrfProcessStateRepository* DtAggregatedMovementActuatorPSR::creator ( const DtString &  rwName, DtLocalObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwBoolean DtAggregatedMovementActuatorPSR::myHaltMovementForObstacles

protected

Whether the actuator should halt movement when encountering obstacles.

DtRwString DtAggregatedMovementActuatorPSR::myObstacleQueryName

protected

The feature query name for obstacles for which the actuator should halt if myHaltMovementForObstacles is set to true.

DtRwBoolean DtAggregatedMovementActuatorPSR::myIsHalted

protected

Whether the actuator is currently halted due to obstacles.

DtRwSimObjectReference DtAggregatedMovementActuatorPSR::myBlockingObstacle

protected

The name of the obstacle that is currently causing us to halt.

DtRwReal DtAggregatedMovementActuatorPSR::myTimeHalted

protected

The time that the actuator halted due to an obstacle.

DtRwNLengthStringVector DtAggregatedMovementActuatorPSR::myObstaclesToIgnore

protected

List of obstacle names which do not need to be halted for.

DtRwNLengthStringVector DtAggregatedMovementActuatorPSR::myUnencounteredObstaclesToIgnore

protected

List of obstacle names which do not need to be halted for that we have not yet encountered.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/aggregatedMovementActuatorPSR.h