VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions
DtNoDataAdminContent< T_functor > Class Template Reference

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.

Inheritance diagram for DtNoDataAdminContent< T_functor >:
Inheritance graph
[legend]

Public Member Functions

 DtNoDataAdminContent ()
 
 DtNoDataAdminContent (const DtNoDataAdminContent &orig)
 
const DtNoDataAdminContentoperator= (const DtNoDataAdminContent &orig)
 
virtual ~DtNoDataAdminContent ()
 
virtual bool init ()
 
virtual const
DtAdminContentMessageType
type () const
 
virtual DtAdminContentclone () const
 
virtual DtString stringRep () const
 
virtual int netRepSize () const
 
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 
virtual bool setToNet ()
 
- Public Member Functions inherited from DtAdminContent
virtual ~DtAdminContent ()
 
virtual charnetRep ()
 

Static Public Member Functions

static DtAdminContentcreate ()
 
- Static Public Member Functions inherited from DtAdminContent
static void addAdminContentCreatorFcn (const DtAdminContentMessageType &contentName, DtAdminContentCreatorFcn fcn)
 
static void setFactory (DtAdminContentFactory *factory)
 
static DtAdminContentFactoryfactory ()
 
static bool isTypeRegistered (const DtAdminContentMessageType &type)
 

Additional Inherited Members

- Protected Member Functions inherited from DtAdminContent
 DtAdminContent ()
 
 DtAdminContent (const DtAdminContent &orig)
 
const DtAdminContentoperator= (const DtAdminContent &orig)
 
virtual charcreateNetworkBuffer ()
 
- Protected Attributes inherited from DtAdminContent
charmyNetRep
 
- Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactorymyFactory
 

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.

References DtAdminContent::operator=().

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 ( void  ) const
inlinevirtual
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 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.

References DtAdminContent::netRepSize().

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

Decodes content from buffer.

Reimplemented from DtAdminContent.

References DtAdminContent::netRepSize(), and DtAdminContent::setFromNet().

template<typename T_functor>
virtual bool DtNoDataAdminContent< T_functor >::setToNet ( )
inlinevirtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

References DtAdminContent::setToNet().


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

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)