DtOrbitTask represents an orbit task for an entity to perform. It inherits read/writableness from SimTask, and includes the center point to orbit, the radius at which to orbit, and flag indicating clockwise or counter clockwise.

Only individual entities can receive this task. This task is never complete, and is only stopped when the entity is destroyed or re-tasked.

task-type: DtOrbitType

Inheritance diagram for DtOrbitTask:

[legend]

Public Member Functions
	DtOrbitTask (const DtString &writeName, const DtOrbitTask &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtOrbitTask &	operator= (const DtOrbitTask &original)

virtual	~DtOrbitTask ()

virtual const DtSimTaskMessageType &	type () const

virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtString	stringRep () const

virtual void	setCenter (const DtVector &center)

virtual DtVector	center () const

virtual const DtUUID &	entityToOrbit () const

virtual void	setEntityToOrbit (const DtUUID &entity)

virtual void	setRadius (double radius)

virtual double	radius () const

virtual void	setClockwise (bool clockwise)

virtual bool	clockwise () const

virtual int	netRepSize () const

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

virtual bool	setToNet ()


	DtOrbitTask ()

	DtOrbitTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtOrbitTask (const DtVector &newCenter, const DtUUID &entity, double newRadius, bool isClockwise)

Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()

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)

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual char *	netRep ()

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)

Private Attributes
DtRwVector	myCenter

DtRwUUID	myEntityToOrbit

DtRwReal	myRadius

DtRwBoolean	myClockwise

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)

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

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

DtOrbitTask::DtOrbitTask ( )

Constructors.

DtOrbitTask::DtOrbitTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Constructors.

DtOrbitTask::DtOrbitTask	(	const DtVector &	newCenter,
		const DtUUID &	entity,
		double	newRadius,
		bool	isClockwise
	)

Constructors.

DtOrbitTask::DtOrbitTask	(	const DtString &	writeName,
		const DtOrbitTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

virtual DtOrbitTask::~DtOrbitTask ( )

virtual

Member Function Documentation

DtOrbitTask& DtOrbitTask::operator= ( const DtOrbitTask & original )

assignment operator

virtual const DtSimTaskMessageType& DtOrbitTask::type ( ) const

virtual

Returns "orbit".

Implements DtSimTask.

virtual DtSimTask* DtOrbitTask::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtOrbitTask::stringRep ( ) const

virtual

Get a readable string representation of this task.

Implements DtSimTask.

virtual void DtOrbitTask::setCenter ( const DtVector & center )

virtual

Point to orbit, in geocentric coordinates.

virtual DtVector DtOrbitTask::center ( ) const

virtual

virtual const DtUUID& DtOrbitTask::entityToOrbit ( ) const

virtual

Optionally you can orbit an object Object name of the entity to orbit.

virtual void DtOrbitTask::setEntityToOrbit ( const DtUUID & entity )

virtual

virtual void DtOrbitTask::setRadius ( double radius )

virtual

Orbital radius, in meters.

virtual double DtOrbitTask::radius ( ) const

virtual

virtual void DtOrbitTask::setClockwise ( bool clockwise )

virtual

Direction to orbit.

virtual bool DtOrbitTask::clockwise ( ) const

virtual

virtual int DtOrbitTask::netRepSize ( ) const

virtual

Returns the size of the network representation.

Reimplemented from DtSimTask.

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

virtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtOrbitTask::setToNet ( )

virtual

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

Reimplemented from DtSimTask.

static DtSimTask* DtOrbitTask::creator ( )

static

Member Data Documentation

DtRwVector DtOrbitTask::myCenter

private

DtRwUUID DtOrbitTask::myEntityToOrbit

private

DtRwReal DtOrbitTask::myRadius

private

DtRwBoolean DtOrbitTask::myClockwise

private

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/orbitTask.h

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation