DtClearTaskByTrackingNumAdminContent Class Reference

Admin content which instructs an entity to clear a specific task based on taskTrackingNumber. More...

Inheritance diagram for DtClearTaskByTrackingNumAdminContent:

Public Member Functions
	DtClearTaskByTrackingNumAdminContent ()
	default constructor More...
	DtClearTaskByTrackingNumAdminContent (const DtClearTaskByTrackingNumAdminContent &orig)
	copy constructor More...
const DtClearTaskByTrackingNumAdminContent &	operator= (const DtClearTaskByTrackingNumAdminContent &orig)
	assignment operator; same as copy costructor. More...
virtual	~DtClearTaskByTrackingNumAdminContent ()
	destructor More...
virtual bool	init ()
	Call after construction. More...
virtual const DtAdminContentMessageType &	type () const
virtual DtAdminContent *	clone () const
	Make a copy of this content. More...
virtual DtString	stringRep () const
	Get a readable string representation of this content. More...
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Decodes content from buffer. More...
virtual bool	setToNet ()
	Encodes content into buffer. More...
virtual void	setTaskTrackingNumber (int n)
	The tracking number of the task to clear. More...
virtual int	taskTrackingNumber () const
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
	destructor More...
virtual char *	netRep ()

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

Protected Attributes
int	myTaskTrackingNumber
Protected Attributes inherited from DtAdminContent
char *	myNetRep

Additional Inherited Members
Protected Member Functions inherited from DtAdminContent
	DtAdminContent ()
	Constructors are protected because no one should instantiate the base class, just derived versions. More...
	DtAdminContent (const DtAdminContent &orig)
	copy constructor More...
const DtAdminContent &	operator= (const DtAdminContent &orig)
	assignment operator; same as copy costructor. More...
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Detailed Description

Admin content which instructs an entity to clear a specific task based on taskTrackingNumber.

Constructor & Destructor Documentation

DtClearTaskByTrackingNumAdminContent::DtClearTaskByTrackingNumAdminContent

(

)

default constructor

DtClearTaskByTrackingNumAdminContent::DtClearTaskByTrackingNumAdminContent

(

const DtClearTaskByTrackingNumAdminContent &

orig

)

copy constructor

virtual DtClearTaskByTrackingNumAdminContent::~DtClearTaskByTrackingNumAdminContent ( )

virtual

destructor

Member Function Documentation

const DtClearTaskByTrackingNumAdminContent& DtClearTaskByTrackingNumAdminContent::operator=

(

const DtClearTaskByTrackingNumAdminContent &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtClearTaskByTrackingNumAdminContent::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtClearTaskByTrackingNumAdminContent::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtClearTaskByTrackingNumAdminContent::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual void DtClearTaskByTrackingNumAdminContent::setTaskTrackingNumber ( int  n )

virtual

The tracking number of the task to clear.

This was set by the message that started the task.

virtual int DtClearTaskByTrackingNumAdminContent::taskTrackingNumber ( ) const

virtual

virtual DtAdminContent* DtClearTaskByTrackingNumAdminContent::clone ( ) const

virtual

Make a copy of this content.

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

Implements DtAdminContent.

virtual DtString DtClearTaskByTrackingNumAdminContent::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtClearTaskByTrackingNumAdminContent::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtClearTaskByTrackingNumAdminContent::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

int DtClearTaskByTrackingNumAdminContent::myTaskTrackingNumber

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrftasks/clearTaskByTrackingNumAdminContent.h