DtSurfaceMovementPSR Class Reference

Inheritance diagram for DtSurfaceMovementPSR:

Public Member Functions
	DtSurfaceMovementPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtSurfaceMovementPSR (const DtSurfaceMovementPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtSurfaceMovementPSR ()
	destructor
DtSurfaceMovementPSR &	operator= (const DtSurfaceMovementPSR &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	setControlObjectName (const DtString &objectName)
	Set/get control object name (name of the waypoint to head towards).
virtual const DtString &	controlObjectName () const
virtual void	setRouteName (const DtString &objectName)
	Set/get route object name (name of the route to follow).
virtual const DtString &	routeName () const
virtual void	setRouteVertices (const DtLocalVectorIterator &routeIterator)
	Set/get route vertices (local coordinates).
virtual const DtLocalVertexList &	routeVertices () const
virtual void	emptyRouteVertices ()
	Empty route vertices.
virtual DtLocalVectorIterator *	routeState () const
	Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).
virtual void	setReverseFlag (bool flag)
	Set/get the reverse flag (reverse the direction of travel while.
virtual bool	reverseFlag () const
virtual void	setFirstWaypoint (const DtString &objectName)
	Set/get the first waypoint object name.
virtual const DtString &	firstWaypoint () const
virtual void	setSecondWaypoint (const DtString &objectName)
	Set/get the second waypoint object name.
virtual const DtString &	secondWaypoint () const
virtual void	setEntityToFollow (const DtString &objectName)
	Set/get the entity to follow object name.
virtual const DtString &	entityToFollow () const
virtual void	setFollowOffsetVector (const DtVector &offset)
	Set/get the entity follow offset (offset vector in body coordinates of the entity to follow, in meters).
virtual const DtVector &	followOffsetVector () const
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to set myCurrentVertex from route state before writing.
virtual void	setWorldAimingPoint (const DtVector &pnt)
	Get/set the point to which this entity is moving towards for a move to location task.
virtual const DtVector &	worldAimingPoint () const
virtual DtReal	maxYawRate () const
	Accessor/mutator for myMaxYawRate.
virtual void	setMaxYawRate (DtReal maxYawRate)
virtual DtReal	maxYawAcceleration () const
	Accessor/mutator for myMaxYawAcceleration.
virtual void	setMaxYawAcceleration (DtReal maxYawAcceleration)
virtual double	stoppingSpeed () const
	Accessor/mutator for myStoppingSpeed.
virtual void	setStoppingSpeed (DtReal stoppingSpeed)
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 DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
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.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

Protected Attributes
DtRwString	myControlObjectName
	Moved here from DtSurfaceEntityMoveToController (surfEntMvToCtl.h)
DtRwString	myRouteName
	Moved here from DtSurfaceEntityMoveAlongController (surfEntMvAlg.h)
DtLocalVectorIterator *	myRouteState
	Route state used to get info about the current route we're trying to follow (e.g.
DtLocalVertexList	myVertices
	my copy of the current route
DtRwInt	myCurrentVertex
	Read/write variables to capture route state.
DtRwBoolean	myReverseFlag
	Moved here from DtSurfaceEntityPatrolRouteController (surfEntPtrlRt.h)
DtRwString	myFirstWaypoint
	Moved here from DtSurfaceEntityPatrolBetweenController (surfEntPtlBtwn.h).
DtRwString	mySecondWaypoint
DtRwString	myEntityToFollow
	Moved here from DtSurfaceFollowEntityController (surfEntFolwCtl.h)
DtRwVector	myFollowOffsetVector
	Following offset vector (in body coordinates of entity to follow, in meters).
DtRwVector	myWorldAimingPoint
	World point for move to location tasks.
DtRwReal	myStoppingSpeed
	Stopping speed. This is the speed used to determine when to stop drifing ships.
DtRwReal	myMaxYawRate
	Max yaw rate.
DtRwReal	myMaxYawAcceleration
	Max yaw rate acceleration.
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtSurfaceMovementPSR::~DtSurfaceMovementPSR ( )

virtual

destructor

Member Function Documentation

DtSurfaceMovementPSR& DtSurfaceMovementPSR::operator=

(

const DtSurfaceMovementPSR &

orig

)

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtSurfaceMovementPSR::type ( ) const

virtual

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

(DtVrfSurfaceMovementProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

virtual void DtSurfaceMovementPSR::setControlObjectName ( const DtString &  objectName )

virtual

Set/get control object name (name of the waypoint to head towards).

virtual const DtString& DtSurfaceMovementPSR::controlObjectName ( ) const

virtual

virtual void DtSurfaceMovementPSR::setRouteName ( const DtString &  objectName )

virtual

Set/get route object name (name of the route to follow).

virtual const DtString& DtSurfaceMovementPSR::routeName ( ) const

virtual

virtual void DtSurfaceMovementPSR::setRouteVertices ( const DtLocalVectorIterator &  routeIterator )

virtual

Set/get route vertices (local coordinates).

Once route is set, can access routeState() to query and set current position along route.

virtual const DtLocalVertexList& DtSurfaceMovementPSR::routeVertices ( ) const

virtual

virtual void DtSurfaceMovementPSR::emptyRouteVertices ( )

virtual

Empty route vertices.

virtual DtLocalVectorIterator* DtSurfaceMovementPSR::routeState ( ) const

virtual

Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).

virtual void DtSurfaceMovementPSR::setReverseFlag ( bool  flag )

virtual

Set/get the reverse flag (reverse the direction of travel while.

patrolling - either between points or along a route).

virtual bool DtSurfaceMovementPSR::reverseFlag ( ) const

virtual

virtual void DtSurfaceMovementPSR::setFirstWaypoint ( const DtString &  objectName )

virtual

Set/get the first waypoint object name.

virtual const DtString& DtSurfaceMovementPSR::firstWaypoint ( ) const

virtual

virtual void DtSurfaceMovementPSR::setSecondWaypoint ( const DtString &  objectName )

virtual

Set/get the second waypoint object name.

virtual const DtString& DtSurfaceMovementPSR::secondWaypoint ( ) const

virtual

virtual void DtSurfaceMovementPSR::setEntityToFollow ( const DtString &  objectName )

virtual

Set/get the entity to follow object name.

virtual const DtString& DtSurfaceMovementPSR::entityToFollow ( ) const

virtual

virtual void DtSurfaceMovementPSR::setFollowOffsetVector ( const DtVector &  offset )

virtual

Set/get the entity follow offset (offset vector in body coordinates of the entity to follow, in meters).

virtual const DtVector& DtSurfaceMovementPSR::followOffsetVector ( ) const

virtual

virtual void DtSurfaceMovementPSR::putSelf ( FILE *  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtReaderWriter::appPath()  )

virtual

Override to set myCurrentVertex from route state before writing.

Reimplemented from DtReaderWriter.

virtual void DtSurfaceMovementPSR::setWorldAimingPoint ( const DtVector &  pnt )

virtual

Get/set the point to which this entity is moving towards for a move to location task.

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

virtual const DtVector& DtSurfaceMovementPSR::worldAimingPoint ( ) const

virtual

virtual DtReal DtSurfaceMovementPSR::maxYawRate ( ) const

virtual

Accessor/mutator for myMaxYawRate.

virtual void DtSurfaceMovementPSR::setMaxYawRate ( DtReal  maxYawRate )

virtual

virtual DtReal DtSurfaceMovementPSR::maxYawAcceleration ( ) const

virtual

Accessor/mutator for myMaxYawAcceleration.

virtual void DtSurfaceMovementPSR::setMaxYawAcceleration ( DtReal  maxYawAcceleration )

virtual

virtual double DtSurfaceMovementPSR::stoppingSpeed ( ) const

virtual

Accessor/mutator for myStoppingSpeed.

virtual void DtSurfaceMovementPSR::setStoppingSpeed ( DtReal  stoppingSpeed )

virtual

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwString DtSurfaceMovementPSR::myControlObjectName

protected

Moved here from DtSurfaceEntityMoveToController (surfEntMvToCtl.h)

Object name of a waypoint we're moving toward.

DtRwString DtSurfaceMovementPSR::myRouteName

protected

Moved here from DtSurfaceEntityMoveAlongController (surfEntMvAlg.h)

Object name of the route object we're following.

DtLocalVectorIterator* DtSurfaceMovementPSR::myRouteState

protected

Route state used to get info about the current route we're trying to follow (e.g.

which vertex to move toward).

DtLocalVertexList DtSurfaceMovementPSR::myVertices

protected

my copy of the current route

DtRwInt DtSurfaceMovementPSR::myCurrentVertex

protected

Read/write variables to capture route state.

DtRwBoolean DtSurfaceMovementPSR::myReverseFlag

protected

Moved here from DtSurfaceEntityPatrolRouteController (surfEntPtrlRt.h)

Current direction of patrol (along route or between waypoints).

DtRwString DtSurfaceMovementPSR::myFirstWaypoint

protected

Moved here from DtSurfaceEntityPatrolBetweenController (surfEntPtlBtwn.h).

Object names of the waypoints to patrol between.

DtRwString DtSurfaceMovementPSR::mySecondWaypoint

protected

DtRwString DtSurfaceMovementPSR::myEntityToFollow

protected

Moved here from DtSurfaceFollowEntityController (surfEntFolwCtl.h)

Object name of entity to follow.

DtRwVector DtSurfaceMovementPSR::myFollowOffsetVector

protected

Following offset vector (in body coordinates of entity to follow, in meters).

DtRwVector DtSurfaceMovementPSR::myWorldAimingPoint

protected

World point for move to location tasks.

DtRwReal DtSurfaceMovementPSR::myStoppingSpeed

protected

Stopping speed. This is the speed used to determine when to stop drifing ships.

DtRwReal DtSurfaceMovementPSR::myMaxYawRate

protected

Max yaw rate.

DtRwReal DtSurfaceMovementPSR::myMaxYawAcceleration

protected

Max yaw rate acceleration.

---

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

• include/vrfobjcore/surfaceMovementPSR.h