DtPathMovementControllerPSR Class Reference

class DtPathMovementControllerPSR: More...

Inheritance diagram for DtPathMovementControllerPSR:

List of all members.

Public Member Functions
	DtPathMovementControllerPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtPathMovementControllerPSR (const DtPathMovementControllerPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtPathMovementControllerPSR ()
	destructor
DtPathMovementControllerPSR &	operator= (const DtPathMovementControllerPSR &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 this process state repository.
virtual void	setMoving (bool moving)
virtual bool	moving () const
virtual void	setPathName (const DtString &pathName)
virtual DtString	pathName () const
virtual bool	pathNameSpecified () const
	Return if the path name is specified. (Setting a path name will specify it)
virtual void	unspecifyPathName ()
	Make the path name unspecified.
virtual void	setDestinationName (const DtString &destinationName)
virtual DtString	destinationName () const
virtual bool	destinationNameSpecified () const
	Return if the destination name is specified. (Setting a destination name will specify it)
virtual void	unspecifyDestinationName ()
	Make the destination name unspecified.
virtual void	setDestinationLocation (const DtVector &destinationLocation)
virtual DtVector	destinationLocation () const
virtual bool	destinationLocationSpecified () const
	Return if the destination location is specified. (Setting a destination location will specify it)
virtual void	unspecifyDestinationLocation ()
	Make the destination location unspecified.
Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Protected Attributes
DtRwBoolean	myMoving
DtRwString	myPathName
DtRwString	myDestinationName
	Name of the generated path.
DtRwVector	myDestinationLocation
	Name of destination object, when moving to named object.

---

Detailed Description

class DtPathMovementControllerPSR:

This is the Process State Repository for the DtPathMovementController component. It stores all necessary pieces of data for that component that must be restored on a scenario load.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtPathMovementControllerPSR::~DtPathMovementControllerPSR

(

)

[virtual]

destructor

---

Member Function Documentation

DtPathMovementControllerPSR& DtPathMovementControllerPSR::operator=

(

const DtPathMovementControllerPSR &

orig

)

assignment operator

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

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtPathMovementControllerPSR::type

(

)

const [virtual]

Returns the string type of this process state repository.

Implements DtVrfProcessStateRepository.

virtual void DtPathMovementControllerPSR::setMoving

(

bool

moving

)

[virtual]

Set/Get whether the component is in Moving mode or Planning mode.

virtual bool DtPathMovementControllerPSR::moving

(

)

const [virtual]

Set/Get whether the component is in Moving mode or Planning mode.

virtual void DtPathMovementControllerPSR::setPathName

(

const DtString &

pathName

)

[virtual]

Set/Get the name of the generated path object.

virtual DtString DtPathMovementControllerPSR::pathName

(

)

const [virtual]

Set/Get the name of the generated path object.

virtual bool DtPathMovementControllerPSR::pathNameSpecified

(

)

const [virtual]

Return if the path name is specified. (Setting a path name will specify it)

virtual void DtPathMovementControllerPSR::unspecifyPathName

(

)

[virtual]

Make the path name unspecified.

virtual void DtPathMovementControllerPSR::setDestinationName

(

const DtString &

destinationName

)

[virtual]

Set/Get the name of the destination object.

virtual DtString DtPathMovementControllerPSR::destinationName

(

)

const [virtual]

Set/Get the name of the destination object.

virtual bool DtPathMovementControllerPSR::destinationNameSpecified

(

)

const [virtual]

Return if the destination name is specified. (Setting a destination name will specify it)

virtual void DtPathMovementControllerPSR::unspecifyDestinationName

(

)

[virtual]

Make the destination name unspecified.

virtual void DtPathMovementControllerPSR::setDestinationLocation

(

const DtVector &

destinationLocation

)

[virtual]

Set/Get the destination location. Destination is stored in world (geocentric) coordinates.

virtual DtVector DtPathMovementControllerPSR::destinationLocation

(

)

const [virtual]

Set/Get the destination location. Destination is stored in world (geocentric) coordinates.

virtual bool DtPathMovementControllerPSR::destinationLocationSpecified

(

)

const [virtual]

Return if the destination location is specified. (Setting a destination location will specify it)

virtual void DtPathMovementControllerPSR::unspecifyDestinationLocation

(

)

[virtual]

Make the destination location unspecified.

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

Returns a newly created instance of this class.

---

Member Data Documentation

DtRwBoolean DtPathMovementControllerPSR::myMoving [protected]

DtRwString DtPathMovementControllerPSR::myPathName [protected]

DtRwString DtPathMovementControllerPSR::myDestinationName [protected]

Name of the generated path.

DtRwVector DtPathMovementControllerPSR::myDestinationLocation [protected]

Name of destination object, when moving to named object.

---

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

• include/vrfobjcore/pathMoveControllerPSR.h