DtCurrentTasksAdminContent Class Reference

Admin content that is used to send the current tasks status from a specific entity. More...

Inheritance diagram for DtCurrentTasksAdminContent:

Public Types
typedef std::list < DtCurrentTaskData >	DtTaskList

Public Member Functions
	DtCurrentTasksAdminContent ()
	default constructor
	DtCurrentTasksAdminContent (const DtCurrentTasksAdminContent &orig)
	copy constructor
const DtCurrentTasksAdminContent &	operator= (const DtCurrentTasksAdminContent &orig)
	assignment operator; same as copy costructor.
virtual	~DtCurrentTasksAdminContent ()
	destructor
virtual bool	init ()
	Call after construction.
virtual const DtAdminContentMessageType &	type () const
virtual void	addTaskToList (const DtSimTask *task, const std::vector< DtSimTaskMessageType > &conflictingTaskTypes)
	Clones the specified task and adds it to the task list in the message.
virtual void	clearTaskList ()
	Removes all the tasks from the task list.
virtual const DtTaskList &	taskList () const
virtual bool	testTaskForConflict (const DtSimTaskMessageType &taskType) const
virtual DtAdminContent *	clone () const
	Make a copy of this content.
virtual DtString	stringRep () const
	Get a readable string representation of this content.
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Decodes content from buffer.
virtual bool	setToNet ()
	Encodes content into buffer.
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
	destructor
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
	Creator function. Returns new instance of this class.
Static Public Member Functions inherited from DtAdminContent
static void	addAdminContentCreatorFcn (const DtString &contentName, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	isTypeRegistered (DtString type)

Protected Member Functions
void	internalClearTaskList ()
	Removes and deletes all tasks on the task list.
void	copyTaskList (const DtTaskList &taskList)
	Clones all tasks in taskList and adds them to myTaskList.
Protected Member Functions inherited from DtAdminContent
	DtAdminContent ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtAdminContent (const DtAdminContent &orig)
	copy constructor
const DtAdminContent &	operator= (const DtAdminContent &orig)
	assignment operator; same as copy costructor.
virtual char *	createNetworkBuffer ()

Protected Attributes
DtTaskList	myTaskList
Protected Attributes inherited from DtAdminContent
char *	myNetRep

Additional Inherited Members
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Detailed Description

Admin content that is used to send the current tasks status from a specific entity.

This message is sent in response to a DtRequstCurrentTasksAdminContent or a subscription to the current task status using the same message. The current task status is a list of all the currently executing top level tasks that an entity has.

Member Typedef Documentation

typedef std::list<DtCurrentTaskData> DtCurrentTasksAdminContent::DtTaskList

Constructor & Destructor Documentation

DtCurrentTasksAdminContent::DtCurrentTasksAdminContent

(

)

default constructor

DtCurrentTasksAdminContent::DtCurrentTasksAdminContent

(

const DtCurrentTasksAdminContent &

orig

)

copy constructor

virtual DtCurrentTasksAdminContent::~DtCurrentTasksAdminContent ( )

virtual

destructor

Member Function Documentation

const DtCurrentTasksAdminContent& DtCurrentTasksAdminContent::operator=

(

const DtCurrentTasksAdminContent &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtCurrentTasksAdminContent::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtCurrentTasksAdminContent::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtCurrentTasksAdminContent::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual void DtCurrentTasksAdminContent::addTaskToList ( const DtSimTask *  task, const std::vector< DtSimTaskMessageType > &  conflictingTaskTypes  )

virtual

Clones the specified task and adds it to the task list in the message.

Associates the specified list of task IDs as the conflicting task IDs to the specified task.

virtual void DtCurrentTasksAdminContent::clearTaskList ( )

virtual

Removes all the tasks from the task list.

virtual const DtTaskList& DtCurrentTasksAdminContent::taskList ( ) const

virtual

Returns

The task list.

Note

The tasks pointed to by this list belong to this admin content, and will be deleted when this admin content is deleted. No not modify or hold on to pointers to these tasks.

virtual bool DtCurrentTasksAdminContent::testTaskForConflict ( const DtSimTaskMessageType &  taskType ) const

virtual

Returns

True if and only if the specified task type appears in any of the conflicting task type lists for any of the tasks contained in the content.

virtual DtAdminContent* DtCurrentTasksAdminContent::clone ( ) const

virtual

Make a copy of this content.

Returns a pointer to a newly created copy of this class.

Implements DtAdminContent.

virtual DtString DtCurrentTasksAdminContent::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtCurrentTasksAdminContent::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtCurrentTasksAdminContent::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

void DtCurrentTasksAdminContent::internalClearTaskList ( )

protected

Removes and deletes all tasks on the task list.

Non-virtual because it is used by the constructors/destructor.

void DtCurrentTasksAdminContent::copyTaskList ( const DtTaskList &  taskList )

protected

Clones all tasks in taskList and adds them to myTaskList.

Note

Does not clear myTaskList first. Non-virtual because it is used by the constructors.

Member Data Documentation

DtTaskList DtCurrentTasksAdminContent::myTaskList

protected

---

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

• include/vrftasks/currentTasksAdminContent.h