DtRotaryWingFlightPSR Class Reference

Inheritance diagram for DtRotaryWingFlightPSR:

Public Types
enum	DtRotaryWingLandingControllerState { StateStartingLandingTask, StateMovingToLandingLocation, StateSettling, StateLanding }
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 )()

Public Member Functions
	DtRotaryWingFlightPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtRotaryWingFlightPSR (const DtRotaryWingFlightPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtRotaryWingFlightPSR ()
DtRotaryWingFlightPSR &	operator= (const DtRotaryWingFlightPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
virtual void	setControlObject (const DtUUID &)
virtual DtSimObjectReference	controlObject () const
virtual void	setRoute (const DtUUID &)
virtual DtSimObjectReference	route () const
virtual void	setRouteVertices (const DtLocalVectorIterator &routeIterator, bool useCurrentVertex=false)
virtual const DtLocalVertexList &	routeVertices () const
virtual void	emptyRouteVertices ()
virtual DtLocalVectorIterator *	routeState () const
virtual void	setWasMovingToward (bool flag)
virtual bool	wasMovingToward () const
virtual void	setStartingPoint (const DtVector &startingPoint)
virtual const DtVector &	startingPoint () const
virtual void	setDoContinueMoving (const bool go)
virtual bool	doContinueMoving () const
virtual void	setReverseFlag (bool flag)
virtual bool	reverseFlag () const
virtual void	setHeadingToTurnTo (double)
virtual double	headingToTurnTo () const
virtual void	setWorldAimingPoint (const DtVector &pnt)
virtual const DtVector &	worldAimingPoint () const
virtual void	setFirstWaypoint (const DtUUID &)
virtual DtSimObjectReference	firstWaypoint () const
virtual void	setSecondWaypoint (const DtUUID &)
virtual DtSimObjectReference	secondWaypoint () const
virtual void	setEntityToFollow (const DtUUID &)
virtual DtSimObjectReference	entityToFollow () const
virtual void	setFollowOffset (const DtVector &offset)
virtual const DtVector &	followOffset () const
virtual void	setMovingToAltitude (bool movingToAlt)
virtual bool	movingToAltitude () const
virtual void	setMoveToAltitudeValue (double altitude)
virtual double	moveToAltitudeValue () const
virtual void	setOrbitRadius (const double r)
virtual double	orbitRadius () const
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
virtual void	setLandingState (DtRotaryWingLandingControllerState state)
virtual DtRotaryWingLandingControllerState	landingState () const
virtual bool	isSpinningUp () const
virtual void	setIsSpinningUp (bool b)
virtual double	spinupCompleteTime () const
virtual void	setSpinupCompleteTime (double t)
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject *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 ()
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwSimObjectReference	myControlObject
DtRwSimObjectReference	myRoute
DtLocalVectorIterator *	myRouteState
DtLocalVertexList	myVertices
DtRwInt	myCurrentVertex
DtRwBoolean	myWasMovingToward
DtRwVector	myStartingPoint
DtRwBoolean	myDoContinueMoving
DtRwBoolean	myReverseFlag
DtRwSimObjectReference	myFirstWaypoint
DtRwSimObjectReference	mySecondWaypoint
DtRwSimObjectReference	myEntityToFollow
DtRwVector	myFollowOffsetVector
DtRwVector	myWorldAimingPoint
DtRwBoolean	myMovingToAltitude
DtRwReal	myMoveToAltitudeValue
DtRwReal	myOrbitRadius
DtRwInt	myLandingState
DtRwReal	myHeadingToTurnTo
DtRwBoolean	myIsSpinningUp
DtRwReal	mySpinupCompleteTime
Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
const DtSimObject *	vrfObject () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Member Enumeration Documentation

enum DtRotaryWingFlightPSR::DtRotaryWingLandingControllerState

State for the DtRotaryWingLandingController.

Enumerator
StateStartingLandingTask
StateMovingToLandingLocation	Moving to a point attached to a parent, or the end of a route, or a settling location above the landing point on the ground:
StateSettling	Zeroing out pitch movement at the settling location.
StateLanding	Attaching to parent, or dropping from settling location to ground.

Constructor & Destructor Documentation

DtRotaryWingFlightPSR::DtRotaryWingFlightPSR	(	DtLocalObject *	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::setControlObject ( const DtUUID &  )

virtual

Get/set the waypoint to move to. For the orbit-entity task, this is the orbit center. Was: setControlObjecName.

virtual DtSimObjectReference DtRotaryWingFlightPSR::controlObject ( ) const

virtual

Was: controlObjectName.

virtual void DtRotaryWingFlightPSR::setRoute ( const DtUUID &  )

virtual

Get/set the route to follow. Was: setRouteName.

virtual DtSimObjectReference DtRotaryWingFlightPSR::route ( ) const

virtual

Was: routeName.

virtual void DtRotaryWingFlightPSR::setRouteVertices ( const DtLocalVectorIterator &  routeIterator, bool  useCurrentVertex = false  )

virtual

Set/get route vertices (local coordinates). Once route is set, can access routeState() to query and set current position along route. If useCurrentVertex is true, use the current vertex whether or not the value is specified.

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::setDoContinueMoving ( const bool  go )

virtual

Get/set the flag that indicates the entity should continue moving (i.e. at ordered speed) at the goal point.

virtual bool DtRotaryWingFlightPSR::doContinueMoving ( ) 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::setHeadingToTurnTo ( double  )

virtual

If tasked to turn to a heading, the heading to turn to.

virtual double DtRotaryWingFlightPSR::headingToTurnTo ( ) 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 DtUUID &  )

virtual

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

virtual DtSimObjectReference DtRotaryWingFlightPSR::firstWaypoint ( ) const

virtual

virtual void DtRotaryWingFlightPSR::setSecondWaypoint ( const DtUUID &  )

virtual

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

virtual DtSimObjectReference DtRotaryWingFlightPSR::secondWaypoint ( ) const

virtual

virtual void DtRotaryWingFlightPSR::setEntityToFollow ( const DtUUID &  )

virtual

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

virtual DtSimObjectReference 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::setOrbitRadius ( const double  r )

virtual

The radius at which to circle for an orbit task.

virtual double DtRotaryWingFlightPSR::orbitRadius ( ) const

virtual

virtual void DtRotaryWingFlightPSR::setLandingState ( DtRotaryWingLandingControllerState  state )

virtual

Accessor/Mutator for myLandingState.

virtual DtRotaryWingLandingControllerState DtRotaryWingFlightPSR::landingState ( ) const

virtual

Accessor/Mutator for myLandingState.

virtual bool DtRotaryWingFlightPSR::isSpinningUp ( ) const

virtual

See Also

myIsSpinningUp

virtual void DtRotaryWingFlightPSR::setIsSpinningUp ( bool  b )

virtual

See Also

myIsSpinningUp

virtual double DtRotaryWingFlightPSR::spinupCompleteTime ( ) const

virtual

See Also

mySpinupCompleteTime

virtual void DtRotaryWingFlightPSR::setSpinupCompleteTime ( double  t )

virtual

See Also

mySpinupCompleteTime

virtual void DtRotaryWingFlightPSR::putSelf ( std::string &  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, DtLocalObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Member Data Documentation

DtRwSimObjectReference DtRotaryWingFlightPSR::myControlObject

protected

Moved here from DtRotaryWingMoveToControllerComponent (rotWngMvToCtl.h).

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

DtRwSimObjectReference DtRotaryWingFlightPSR::myRoute

protected

Moved here from DtRotaryWingMoveAlongControllerComponent (rotaryWingFlightPSR.h).

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

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::myDoContinueMoving

protected

A flag to indicate if the entity should continue moving when it reaches its goal.

DtRwBoolean DtRotaryWingFlightPSR::myReverseFlag

protected

Moved here from DtRotaryWingPatrolRouteController (rotWingPtrlRt.h).

DtRwSimObjectReference DtRotaryWingFlightPSR::myFirstWaypoint

protected

Moved here from DtRotaryWingPatrolBetweenController (rotWngPtlBtwn.h).

DtRwSimObjectReference DtRotaryWingFlightPSR::mySecondWaypoint

protected

DtRwSimObjectReference 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

DtRwReal DtRotaryWingFlightPSR::myOrbitRadius

protected

DtRwInt DtRotaryWingFlightPSR::myLandingState

protected

DtRwReal DtRotaryWingFlightPSR::myHeadingToTurnTo

protected

DtRwBoolean DtRotaryWingFlightPSR::myIsSpinningUp

protected

True if the RW is currently in the processing of spinning up.

DtRwReal DtRotaryWingFlightPSR::mySpinupCompleteTime

protected

If myIsSpinningUp is true, this is the simulation time at which spinup is complete.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/rotaryWingFlightPSR.h