DtRotaryWingFlightPSR Class Reference

Inheritance diagram for DtRotaryWingFlightPSR:

Public Types
enum	DtRotaryWingLandingControllerState { StateStartingLandingTask, StateMovingToLandingLocation, StateLanding }
	State for the DtRotaryWingLandingController. More...

Public Member Functions
	DtRotaryWingFlightPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtRotaryWingFlightPSR (const DtRotaryWingFlightPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtRotaryWingFlightPSR ()
	destructor
DtRotaryWingFlightPSR &	operator= (const DtRotaryWingFlightPSR &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)
	Get/set the name of the waypoint to move to.
virtual const DtString &	controlObjectName () const
virtual void	setRouteName (const DtString &routeName)
	Get/set the 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	setWasMovingToward (bool flag)
	Get/set the flag indicating whether or not the last tick was moving.
virtual bool	wasMovingToward () const
virtual void	setStartingPoint (const DtVector &startingPoint)
	Get/set the starting point of the current segment of a route we're moving along.
virtual const DtVector &	startingPoint () const
virtual void	setReverseFlag (bool flag)
	Get/set the reverse patrol flag (along a route or between points).
virtual bool	reverseFlag () const
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 void	setFirstWaypoint (const DtString &objectName)
	Get/set the object name of the first waypoint we're patrolling between.
virtual const DtString &	firstWaypoint () const
virtual void	setSecondWaypoint (const DtString &objectName)
	Get/set the object name of the second waypoint we're patrolling between.
virtual const DtString &	secondWaypoint () const
virtual void	setEntityToFollow (const DtString &objectName)
	Get/set the object name of the entity to follow.
virtual const DtString &	entityToFollow () const
virtual void	setFollowOffset (const DtVector &offset)
	Get/set the following offset (in body coordinates of the entity to follow, in meters).
virtual const DtVector &	followOffset () const
virtual void	setMovingToAltitude (bool movingToAlt)
	Should be true when processing a move to altitude task.
virtual bool	movingToAltitude () const
	Should be true when processing a move to altitude task.
virtual void	setMoveToAltitudeValue (double altitude)
	Set the requested altitude from the move to altitude task.
virtual double	moveToAltitudeValue () const
	The requested altitude from the move to altitude task.
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	setLandingState (DtRotaryWingLandingControllerState state)
	Accessor/Mutator for myLandingState.
virtual DtRotaryWingLandingControllerState	landingState () const
	Accessor/Mutator for myLandingState.
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)
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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 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.
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.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Attributes
DtRwString	myControlObjectName
	Moved here from DtRotaryWingMoveToControllerComponent (rotWngMvToCtl.h).
DtRwString	myRouteName
	Moved here from DtRotaryWingMoveAlongControllerComponent (rotaryWingFlightPSR.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	myWasMovingToward
	A flag indicating whether or not the last tick was moving toward the current waypoint.
DtRwVector	myStartingPoint
	A vector indicating the starting point of the current segment.
DtRwBoolean	myReverseFlag
	Moved here from DtRotaryWingPatrolRouteController (rotWingPtrlRt.h).
DtRwString	myFirstWaypoint
	Moved here from DtRotaryWingPatrolBetweenController (rotWngPtlBtwn.h).
DtRwString	mySecondWaypoint
DtRwString	myEntityToFollow
	Set when a patrol between task is received.
DtRwVector	myFollowOffsetVector
	Following offset vector (in body coordinates of the entity to follow, in meters).
DtRwVector	myWorldAimingPoint
	World point for move to location tasks.
DtRwBoolean	myMovingToAltitude
DtRwReal	myMoveToAltitudeValue
DtRwInt	myLandingState
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
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Member Enumeration Documentation

enum DtRotaryWingFlightPSR::DtRotaryWingLandingControllerState

State for the DtRotaryWingLandingController.

Enumerator:

StateStartingLandingTask
StateMovingToLandingLocation
StateLanding

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtRotaryWingFlightPSR::~DtRotaryWingFlightPSR ( )

virtual

destructor

Member Function Documentation

DtRotaryWingFlightPSR& DtRotaryWingFlightPSR::operator=

(

const DtRotaryWingFlightPSR &

orig

)

assignment operator

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

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

virtual DtString DtRotaryWingFlightPSR::type ( ) const

virtual

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

(DtVrfRotaryWingFlightProcessStateRepositoryType).

Implements DtVrfProcessStateRepository.

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

virtual

Get/set the name of the waypoint to move to.

virtual const DtString& DtRotaryWingFlightPSR::controlObjectName ( ) const

virtual

virtual void DtRotaryWingFlightPSR::setRouteName ( const DtString &  routeName )

virtual

Get/set the name of the route to follow.

virtual const DtString& DtRotaryWingFlightPSR::routeName ( ) const

virtual

virtual void DtRotaryWingFlightPSR::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& DtRotaryWingFlightPSR::routeVertices ( ) const

virtual

virtual void DtRotaryWingFlightPSR::emptyRouteVertices ( )

virtual

Empty route vertices.

virtual DtLocalVectorIterator* DtRotaryWingFlightPSR::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 DtRotaryWingFlightPSR::setWasMovingToward ( bool  flag )

virtual

Get/set the flag indicating whether or not the last tick was moving.

toward the current waypoint.

virtual bool DtRotaryWingFlightPSR::wasMovingToward ( ) const

virtual

virtual void DtRotaryWingFlightPSR::setStartingPoint ( const DtVector &  startingPoint )

virtual

Get/set the starting point of the current segment of a route we're moving along.

virtual const DtVector& DtRotaryWingFlightPSR::startingPoint ( ) const

virtual

virtual void DtRotaryWingFlightPSR::setReverseFlag ( bool  flag )

virtual

Get/set the reverse patrol flag (along a route or between points).

virtual bool DtRotaryWingFlightPSR::reverseFlag ( ) const

virtual

virtual void DtRotaryWingFlightPSR::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& DtRotaryWingFlightPSR::worldAimingPoint ( ) const

virtual

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

virtual

Get/set the object name of the first waypoint we're patrolling between.

virtual const DtString& DtRotaryWingFlightPSR::firstWaypoint ( ) const

virtual

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

virtual

Get/set the object name of the second waypoint we're patrolling between.

virtual const DtString& DtRotaryWingFlightPSR::secondWaypoint ( ) const

virtual

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

virtual

Get/set the object name of the entity to follow.

virtual const DtString& DtRotaryWingFlightPSR::entityToFollow ( ) const

virtual

virtual void DtRotaryWingFlightPSR::setFollowOffset ( const DtVector &  offset )

virtual

Get/set the following offset (in body coordinates of the entity to follow, in meters).

virtual const DtVector& DtRotaryWingFlightPSR::followOffset ( ) const

virtual

virtual void DtRotaryWingFlightPSR::setMovingToAltitude ( bool  movingToAlt )

virtual

Should be true when processing a move to altitude task.

virtual bool DtRotaryWingFlightPSR::movingToAltitude ( ) const

virtual

Should be true when processing a move to altitude task.

virtual void DtRotaryWingFlightPSR::setMoveToAltitudeValue ( double  altitude )

virtual

Set the requested altitude from the move to altitude task.

virtual double DtRotaryWingFlightPSR::moveToAltitudeValue ( ) const

virtual

The requested altitude from the move to altitude task.

virtual void DtRotaryWingFlightPSR::setLandingState ( DtRotaryWingLandingControllerState  state )

virtual

Accessor/Mutator for myLandingState.

virtual DtRotaryWingLandingControllerState DtRotaryWingFlightPSR::landingState ( ) const

virtual

Accessor/Mutator for myLandingState.

virtual void DtRotaryWingFlightPSR::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.

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

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwString DtRotaryWingFlightPSR::myControlObjectName

protected

Moved here from DtRotaryWingMoveToControllerComponent (rotWngMvToCtl.h).

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

DtRwString DtRotaryWingFlightPSR::myRouteName

protected

Moved here from DtRotaryWingMoveAlongControllerComponent (rotaryWingFlightPSR.h).

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

DtLocalVectorIterator* DtRotaryWingFlightPSR::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 DtRotaryWingFlightPSR::myVertices

protected

my copy of the current route

DtRwInt DtRotaryWingFlightPSR::myCurrentVertex

protected

Read/write variables to capture route state.

DtRwBoolean DtRotaryWingFlightPSR::myWasMovingToward

protected

A flag indicating whether or not the last tick was moving toward the current waypoint.

DtRwVector DtRotaryWingFlightPSR::myStartingPoint

protected

A vector indicating the starting point of the current segment.

DtRwBoolean DtRotaryWingFlightPSR::myReverseFlag

protected

Moved here from DtRotaryWingPatrolRouteController (rotWingPtrlRt.h).

DtRwString DtRotaryWingFlightPSR::myFirstWaypoint

protected

Moved here from DtRotaryWingPatrolBetweenController (rotWngPtlBtwn.h).

DtRwString DtRotaryWingFlightPSR::mySecondWaypoint

protected

DtRwString DtRotaryWingFlightPSR::myEntityToFollow

protected

Set when a patrol between task is received.

Reuse the myReverseFlag from DtRotaryWingPatrolRouteController. bool myReverseFlag; Moved here from DtRotaryWingFollowEntityController (rotWngFolwCtl.h)

Object name of an entity to follow.

DtRwVector DtRotaryWingFlightPSR::myFollowOffsetVector

protected

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

DtRwVector DtRotaryWingFlightPSR::myWorldAimingPoint

protected

World point for move to location tasks.

DtRwBoolean DtRotaryWingFlightPSR::myMovingToAltitude

protected

DtRwReal DtRotaryWingFlightPSR::myMoveToAltitudeValue

protected

DtRwInt DtRotaryWingFlightPSR::myLandingState

protected

---

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

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