Inheritance diagram for DtUserTask:

Public Member Functions
	DtUserTask ()
	default constructor
	DtUserTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
virtual	~DtUserTask ()
	destructor
	DtUserTask (const DtString &writeName, const DtUserTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtUserTask &	operator= (const DtUserTask &orig)
	assignment operator
virtual int	type () const
	Returns "user-defined-task".
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this user-defined task.
virtual DtString	stringRep () const
	Returns a human-readable string representation of the task.
virtual const DtString &	userTaskName () const
	Set/get the name of the user-defined task.
virtual void	setUserTaskName (const DtString &taskName)
virtual const DtString &	arg1Text () const
	Set/get the 1st argument.
virtual void	setArg1Text (const DtString &value)
virtual const DtString &	arg2Text () const
	Set/get the 2nd argument.
virtual void	setArg2Text (const DtString &value)
virtual const DtString &	arg3Text () const
	Set/get the 3rd argument.
virtual void	setArg3Text (const DtString &value)
virtual const DtString &	arg4Text () const
	Set/get the 4th argument.
virtual void	setArg4Text (const DtString &value)
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
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.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwString	myUserTaskName
DtRwString	myArg1Text
DtRwString	myArg2Text
DtRwString	myArg3Text
DtRwString	myArg4Text

Detailed Description

class DtUserTask:

Instances of DtUserTask are tasks defined by the user. The parameters for the task are stored as a list of strings.

DtUserTask is a specialized task that acts as a container for a user-defined task. There is no inherent action associated with a user task. It is generic task shell, meant to be used to convey the data associated with a new kind of task. It contains a number of generic string parameters, which the user uses to specify a name for the new task type, and any parameters neces- sary to fully describe the task. The user task can be used from within a plan, as you would any other task. It can also be configured through the GUI in the same way you would normally configure tasks.

task-type: DtUserTaskType

parameters: user task name - A unique string name identifying the specific user task. The name can be used in the components that register for DtUserTask messages to identify the particular user-defined task.

generic string arguments [4] - A user task can use up to four text strings to store parameters for the task. It is up to the user to deter- mine the content of the parameters.

Constructor & Destructor Documentation

DtUserTask::DtUserTask ( )

default constructor

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

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

virtual DtUserTask::~DtUserTask ( ) [virtual]

destructor

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

copy constructor

Member Function Documentation

DtUserTask& DtUserTask::operator= ( const DtUserTask & orig )

assignment operator

virtual int DtUserTask::type ( ) const [virtual]

Returns "user-defined-task".

Implements DtSimTask.

Reimplemented in BHAVE::DtBhaveTask.

virtual DtSimTask* DtUserTask::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const `[virtual]`

Creates a copy of this user-defined task.

Implements DtSimTask.

Reimplemented in BHAVE::DtBhaveTask.

virtual DtString DtUserTask::stringRep ( ) const [virtual]

Returns a human-readable string representation of the task.

This string representation is used to display information about the task in the plan editor and viewer. The type and parameters for the task are typically encoded in the string. The format of the string is up to you.

Implements DtSimTask.

Reimplemented in BHAVE::DtBhaveTask.

static DtSimTask* DtUserTask::creator ( ) [static]

Reimplemented in BHAVE::DtBhaveTask.

virtual const DtString& DtUserTask::userTaskName ( ) const [virtual]

Set/get the name of the user-defined task.

virtual void DtUserTask::setUserTaskName ( const DtString & taskName ) [virtual]