DtHumanFollowPSR Class Reference

class DtHumanFollowPSR: More...

Inheritance diagram for DtHumanFollowPSR:

List of all members.

Public Member Functions
	DtHumanFollowPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtHumanFollowPSR (const DtHumanFollowPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtHumanFollowPSR ()
	destructor
DtHumanFollowPSR &	operator= (const DtHumanFollowPSR &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	setEntityToFollow (const DtString &objectName)
	Get/set the name of the entity to follow.
virtual const DtString &	entityToFollow () const
	Get/set the name of the entity to follow.
virtual void	setFollowingOffsetVector (const DtVector &offsetVector)
	Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow).
virtual const DtVector &	followingOffsetVector () const
	Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow).
virtual void	setControlObjectName (const DtString &controlObjectName)
	Get/set the name of the control object to move to (waypoint name).
virtual const DtString &	controlObjectName () const
	Get/set the name of the control object to move to (waypoint name).
virtual void	setWorldDestination (const DtVector &destination)
	Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
virtual const DtVector &	worldDestination () const
	Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Protected Attributes
DtRwString	myEntityToFollow
	From DtGroundFollowEntityController (gndFollwCtl.h)
DtRwVector	myOffsetVector
DtRwString	myControlObjectName
	From DtGroundMoveToControllerComponent (gndMvToCntlr.h)
DtRwVector	myWorldDestination
	World point for move to location tasks.

---

Detailed Description

class DtHumanFollowPSR:

Instances of DtHumanFollowPSR are used to hold the shared/checkpointable data for an automotive system.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtHumanFollowPSR::~DtHumanFollowPSR

(

)

[virtual]

destructor

---

Member Function Documentation

DtHumanFollowPSR& DtHumanFollowPSR::operator=

(

const DtHumanFollowPSR &

orig

)

assignment operator

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

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtHumanFollowPSR::type

(

)

const [virtual]

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

(DtHumanFollowPSRType).

Implements DtVrfProcessStateRepository.

virtual void DtHumanFollowPSR::setEntityToFollow

(

const DtString &

objectName

)

[virtual]

Get/set the name of the entity to follow.

virtual const DtString& DtHumanFollowPSR::entityToFollow

(

)

const [virtual]

Get/set the name of the entity to follow.

virtual void DtHumanFollowPSR::setFollowingOffsetVector

(

const DtVector &

offsetVector

)

[virtual]

Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow).

virtual const DtVector& DtHumanFollowPSR::followingOffsetVector

(

)

const [virtual]

Get/set the offset vector to use when following (offset is in terms of the body coordinate system of the entity to follow).

virtual void DtHumanFollowPSR::setControlObjectName

(

const DtString &

controlObjectName

)

[virtual]

Get/set the name of the control object to move to (waypoint name).

virtual const DtString& DtHumanFollowPSR::controlObjectName

(

)

const [virtual]

Get/set the name of the control object to move to (waypoint name).

virtual void DtHumanFollowPSR::setWorldDestination

(

const DtVector &

destination

)

[virtual]

Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.

This point is only valid for that task and is set in world (geocentric) coordinates

virtual const DtVector& DtHumanFollowPSR::worldDestination

(

)

const [virtual]

Get/set the location to which this entity is moving towards for a move to destination (or derivative) task.

This point is only valid for that task and is set in world (geocentric) coordinates

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

Returns a newly created instance of this class.

---

Member Data Documentation

DtRwString DtHumanFollowPSR::myEntityToFollow [protected]

From DtGroundFollowEntityController (gndFollwCtl.h)

Set when a follow entity task is received.

DtRwVector DtHumanFollowPSR::myOffsetVector [protected]

DtRwString DtHumanFollowPSR::myControlObjectName [protected]

From DtGroundMoveToControllerComponent (gndMvToCntlr.h)

If tasked() is true, this is the name of the control object we're moving to.

DtRwVector DtHumanFollowPSR::myWorldDestination [protected]

World point for move to location tasks.

---

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

• include/vrfobjcore/humanFollowPSR.h