DtOrbitTask Class Reference

DtOrbitTask represents an orbit task for an entity to perform. More...

Inheritance diagram for DtOrbitTask:

Public Member Functions
	DtOrbitTask (const DtString &writeName, const DtOrbitTask &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtOrbitTask &	operator= (const DtOrbitTask &original)
	assignment operator
virtual	~DtOrbitTask ()
virtual const DtSimTaskMessageType &	type () const
	Returns "orbit".
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
	Creates a copy of this task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual void	setCenter (const DtVector &center)
	Point to orbit, in geocentric coordinates.
virtual DtVector	center () const
virtual void	setRadius (double radius)
	Orbital radius, in meters.
virtual double	radius () const
virtual void	setClockwise (bool clockwise)
	Direction to orbit.
virtual bool	clockwise () const
virtual int	netRepSize () const
	Returns the size of the network representation.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
	DtOrbitTask ()
	Constructors.
	DtOrbitTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Constructors.
	DtOrbitTask (const DtVector &newCenter, double newRadius, bool isClockwise)
	Constructors.
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
	If true, this task is a subtask.
virtual bool	subtask () const
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual char *	netRep ()
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	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 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 DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
	Static functions.
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
	Adds a task creator member function to the task factory.
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	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.

Private Attributes
DtRwVector	myCenter
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::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Member Functions inherited from DtSimTask
	DtSimTask ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the write name will preface the task.
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimTask &	operator= (const DtSimTask &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
char *	myNetRep
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory

Detailed Description

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

Constructor & Destructor Documentation

DtOrbitTask::DtOrbitTask

(

)

Constructors.

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

Constructors.

DtOrbitTask::DtOrbitTask	(	const DtVector &	newCenter,
		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 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

DtRwReal DtOrbitTask::myRadius

private

DtRwBoolean DtOrbitTask::myClockwise

private

---

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

• include/vrftasks/orbitTask.h