class DtHumanCollisionAvoidancePSR: More...

Inheritance diagram for DtHumanCollisionAvoidancePSR:

Public Member Functions
	DtHumanCollisionAvoidancePSR (DtVrfObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
	constructor
	DtHumanCollisionAvoidancePSR (const DtHumanCollisionAvoidancePSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtHumanCollisionAvoidancePSR ()
	destructor
DtHumanCollisionAvoidancePSR &	operator= (const DtHumanCollisionAvoidancePSR &orig)
	assignment operator
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.

virtual void	setIsColliding (bool colliding)
	Get/set flag indicating if we are currently in a colliding state.
virtual bool	isColliding () const
	Get/set flag indicating if we are currently in a colliding state.

virtual void	setIsClearing (bool clearing)
	Get/set flag indicating if we are currently clearing a collision.
virtual bool	isClearing () const
	Get/set flag indicating if we are currently clearing a collision.
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject 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 ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 (FILE *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 (FILE *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.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal 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 void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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)
	The variable name, if this object is a variable reference.
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 ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
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 ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
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 &)
	Restires 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.
DtRwBoolean	myIsColliding
	Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
DtRwBoolean	myIsClearing
	Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
DtRwBoolean	myAvoidingLeft
	Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
DtRwReal	myAvoidingHeading
	Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
DtRwReal	myClearingDistance
	Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
virtual void	setAvoidingLeft (bool avoidingLeft)
	Get/set flag indicating if we are turning to left to avoid collision.
virtual bool	avoidingLeft () const
	Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
virtual void	setAvoidingHeading (double heading)
	Get/set heading we're using to avoid collision.
virtual double	avoidingHeading () const
	Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
virtual void	setClearingDistance (double distance)
	Get/set heading we're using to avoid collision.
virtual double	clearingDistance () const
	Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry)
	Returns a newly created instance of this class.

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 Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry=0)
	Creates a new state repository object, using the factory.
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

class DtHumanCollisionAvoidancePSR:

Instances of DtHumanCollisionAvoidancePSR are used to hold the shared/checkpointable data for a human entity.

Constructor & Destructor Documentation

DtHumanCollisionAvoidancePSR::DtHumanCollisionAvoidancePSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

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

copy constructor

virtual DtHumanCollisionAvoidancePSR::~DtHumanCollisionAvoidancePSR ( )

virtual

destructor

Member Function Documentation

DtHumanCollisionAvoidancePSR& DtHumanCollisionAvoidancePSR::operator= ( const DtHumanCollisionAvoidancePSR & orig )

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtHumanCollisionAvoidancePSR::type ( ) const

virtual

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

(DtHumanCollisionAvoidancePSRType).

Implements DtVrfProcessStateRepository.

virtual void DtHumanCollisionAvoidancePSR::setIsColliding ( bool colliding )

virtual

Get/set flag indicating if we are currently in a colliding state.

virtual bool DtHumanCollisionAvoidancePSR::isColliding ( ) const

virtual

Get/set flag indicating if we are currently in a colliding state.

virtual void DtHumanCollisionAvoidancePSR::setIsClearing ( bool clearing )

virtual

Get/set flag indicating if we are currently clearing a collision.

virtual bool DtHumanCollisionAvoidancePSR::isClearing ( ) const

virtual

Get/set flag indicating if we are currently clearing a collision.

virtual void DtHumanCollisionAvoidancePSR::setAvoidingLeft ( bool avoidingLeft )

virtual

Get/set flag indicating if we are turning to left to avoid collision.

virtual bool DtHumanCollisionAvoidancePSR::avoidingLeft ( ) const

virtual

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

virtual void DtHumanCollisionAvoidancePSR::setAvoidingHeading ( double heading )

virtual

Get/set heading we're using to avoid collision.

virtual double DtHumanCollisionAvoidancePSR::avoidingHeading ( ) const

virtual

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

virtual void DtHumanCollisionAvoidancePSR::setClearingDistance ( double distance )

virtual

Get/set heading we're using to avoid collision.

virtual double DtHumanCollisionAvoidancePSR::clearingDistance ( ) const

virtual

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

static DtVrfProcessStateRepository* DtHumanCollisionAvoidancePSR::creator	(	const DtString &	rwName,
		DtVrfObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry
	)

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwBoolean DtHumanCollisionAvoidancePSR::myIsColliding

protected

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

DtRwBoolean DtHumanCollisionAvoidancePSR::myIsClearing

protected

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

DtRwBoolean DtHumanCollisionAvoidancePSR::myAvoidingLeft

protected

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

DtRwReal DtHumanCollisionAvoidancePSR::myAvoidingHeading

protected

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

DtRwReal DtHumanCollisionAvoidancePSR::myClearingDistance

protected

Changed myCollidee from DtEntityIdentifier to object name so we can save it across scenario runs.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/humanCollisionAvoidancePSR.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation