DtNoDataAdminContent< T_functor > Class Template Reference

Class for DtAdminContent subclasses that contain no data. More...

Inheritance diagram for DtNoDataAdminContent< T_functor >:

Public Member Functions
	DtNoDataAdminContent ()
	default constructor
	DtNoDataAdminContent (const DtNoDataAdminContent &orig)
	copy constructor
const DtNoDataAdminContent &	operator= (const DtNoDataAdminContent &orig)
	assignment operator; same as copy costructor.
virtual	~DtNoDataAdminContent ()
	destructor
virtual bool	init ()
	Call after construction.
virtual const DtAdminContentMessageType &	type () 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)

Additional Inherited Members
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 inherited from DtAdminContent
char *	myNetRep
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Detailed Description

template<typename T_functor>
class DtNoDataAdminContent< T_functor >

Class for DtAdminContent subclasses that contain no data.

This class allows easy creation of DtAdminContent subclasses that have no data other than their type. Simply inherit this class with and override the type function to return the content message type It is also recommended to override the stringRep() member, so that it returns a relevant string.

Constructor & Destructor Documentation

template<typename T_functor>

DtNoDataAdminContent< T_functor >::DtNoDataAdminContent ( )

inline

default constructor

template<typename T_functor>

DtNoDataAdminContent< T_functor >::DtNoDataAdminContent ( const DtNoDataAdminContent< T_functor > &  orig )

inline

copy constructor

template<typename T_functor>

virtual DtNoDataAdminContent< T_functor >::~DtNoDataAdminContent ( )

inlinevirtual

destructor

Member Function Documentation

template<typename T_functor>

const DtNoDataAdminContent& DtNoDataAdminContent< T_functor >::operator= ( const DtNoDataAdminContent< T_functor > &  orig )

inline

assignment operator; same as copy costructor.

template<typename T_functor>

static DtAdminContent* DtNoDataAdminContent< T_functor >::create ( )

inlinestatic

Creator function. Returns new instance of this class.

template<typename T_functor>

virtual bool DtNoDataAdminContent< T_functor >::init ( void  )

inlinevirtual

Call after construction.

Reimplemented from DtAdminContent.

References DtAdminContent::init().

template<typename T_functor>

virtual const DtAdminContentMessageType& DtNoDataAdminContent< T_functor >::type ( ) const

inlinevirtual

Returns

Implements DtAdminContent.

Referenced by DtNoDataAdminContent< T_functor >::stringRep().

template<typename T_functor>

virtual DtAdminContent* DtNoDataAdminContent< T_functor >::clone ( ) const

inlinevirtual

Make a copy of this content.

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

Implements DtAdminContent.

template<typename T_functor>

virtual DtString DtNoDataAdminContent< T_functor >::stringRep ( ) const

inlinevirtual

Get a readable string representation of this content.

Note

It is recommended that instances of this template class specialize this method to provide a string representation.

Implements DtAdminContent.

References DtVrfObjectMessageTypeTemplate< msgTypeInt >::string(), and DtNoDataAdminContent< T_functor >::type().

template<typename T_functor>

virtual int DtNoDataAdminContent< T_functor >::netRepSize ( ) const

inlinevirtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

Referenced by DtNoDataAdminContent< T_functor >::setFromNet().

template<typename T_functor>

virtual bool DtNoDataAdminContent< T_functor >::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

inlinevirtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

References DtNoDataAdminContent< T_functor >::netRepSize().

template<typename T_functor>

virtual bool DtNoDataAdminContent< T_functor >::setToNet ( )

inlinevirtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrftasks/noDataAdminContent.h