DtTurnToHeadingTask Class Reference

This struct is the FIXED portion of the simulation network representation of a turn to heading task.

DtTurnToHeadingTask commands an entity to turn to a specified heading. Pivot capable entities may do so withourt otherwise moving.

task-type: DtTurnToHeadingType

parameters: heading - Heading to turn to.

          mode - The mode in which to set the heading:
          0 - Absolute - Sets the heading to be the heading given
          1 - Relative to host - If embarked, sets the heading to be the heading
              on the host object
          2 - Sets the heading to be the heading + the delta given to be the
              new heading 

Inheritance diagram for DtTurnToHeadingTask:

Public Member Functions
	DtTurnToHeadingTask ()
	DtTurnToHeadingTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtTurnToHeadingTask (const DtString &writeName, const DtTurnToHeadingTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtTurnToHeadingTask &	operator= (const DtTurnToHeadingTask &orig)
virtual	~DtTurnToHeadingTask () override
virtual const DtSimTaskMessageType &	type () const override
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	stringRep () const override
virtual void	setHeading (DtReal heading)
virtual DtReal	heading () const
virtual int	mode () const
virtual void	setMode (int)
virtual bool	allowKTurn () const
virtual void	setAllowKTurn (const bool c)
virtual bool	continueAtEnd () const
virtual void	setContinueAtEnd (const bool p)
virtual double	desiredTurnRadius () const
virtual bool	turnRadiusSpecified () const
virtual void	setDesiredTurnRadius (const double r)
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask () override
virtual bool	init ()
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
virtual bool	subtask () const
virtual void	setAllowTaskVisualizations (bool flag)
virtual bool	allowTaskVisualizations () const
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual char *	netRep ()
virtual bool	isOneClick () const
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) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
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 DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	factory ()
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
DtRwReal	myHeading
DtRwInt	myMode
DtRwBoolean	myAllowKTurn
DtRwReal	myDesiredTurnRadius
DtRwBoolean	myContinueAtEnd
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
DtRwBoolean	myAllowTaskVisualizations
char *	myNetRep
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
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 )()
Protected Member Functions inherited from DtSimTask
	DtSimTask ()
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimTask &	operator= (const DtSimTask &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory
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

Constructor & Destructor Documentation

DtTurnToHeadingTask::DtTurnToHeadingTask

(

)

default constructor

DtTurnToHeadingTask::DtTurnToHeadingTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a task 'put' itself, the writeName will preface the task.

DtTurnToHeadingTask::DtTurnToHeadingTask	(	const DtString &	writeName,
		const DtTurnToHeadingTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtTurnToHeadingTask::~DtTurnToHeadingTask ( )

overridevirtual

Member Function Documentation

const DtTurnToHeadingTask& DtTurnToHeadingTask::operator=

(

const DtTurnToHeadingTask &

orig

)

assignment operator

virtual const DtSimTaskMessageType& DtTurnToHeadingTask::type ( ) const

overridevirtual

Returns DtTurnToHeadingType.

Implements DtSimTask.

virtual DtSimTask* DtTurnToHeadingTask::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

overridevirtual

Creates a copy of this wait task.

Implements DtSimTask.

virtual DtString DtTurnToHeadingTask::stringRep ( ) const

overridevirtual

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtTurnToHeadingTask::setHeading ( DtReal  heading )

virtual

virtual DtReal DtTurnToHeadingTask::heading ( ) const

virtual

virtual int DtTurnToHeadingTask::mode ( ) const

virtual

virtual void DtTurnToHeadingTask::setMode ( int  )

virtual

virtual bool DtTurnToHeadingTask::allowKTurn ( ) const

virtual

virtual void DtTurnToHeadingTask::setAllowKTurn ( const bool  c )

virtual

virtual bool DtTurnToHeadingTask::continueAtEnd ( ) const

virtual

virtual void DtTurnToHeadingTask::setContinueAtEnd ( const bool  p )

virtual

virtual double DtTurnToHeadingTask::desiredTurnRadius ( ) const

virtual

Desired turn radius is the distance to the right, i.e. the +y direction, of the turn center from the entity y center. If this is negative, then the turn center is to the left. If the desired radius value is 0, then the minimum turn radius should be used. Controllers that process this message should also check valueSpecified; if no value is specified, then the current speed etc. can be used to determine an appropriate turn radius for the task.

virtual bool DtTurnToHeadingTask::turnRadiusSpecified ( ) const

virtual

virtual void DtTurnToHeadingTask::setDesiredTurnRadius ( const double  r )

virtual

virtual int DtTurnToHeadingTask::netRepSize ( ) const

overridevirtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSimTask.

virtual bool DtTurnToHeadingTask::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

overridevirtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtTurnToHeadingTask::setToNet ( )

overridevirtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSimTask.

static DtSimTask* DtTurnToHeadingTask::creator ( )

static

Member Data Documentation

DtRwReal DtTurnToHeadingTask::myHeading

protected

DtRwInt DtTurnToHeadingTask::myMode

protected

DtRwBoolean DtTurnToHeadingTask::myAllowKTurn

protected

DtRwReal DtTurnToHeadingTask::myDesiredTurnRadius

protected

DtRwBoolean DtTurnToHeadingTask::myContinueAtEnd

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrftasks/turnToHeadingTask.h