VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions
DtNoDataAdminContent< T_contentType > Class Template Reference

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

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

List of all members.

Public Member Functions

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

Static Public Member Functions

static DtAdminContentcreate ()
 Creator function. Returns new instance of this class.

Detailed Description

template<int T_contentType>
class DtNoDataAdminContent< T_contentType >

Class template for DtAdminContent subclasses that contain no data.

This template allows easy creation of DtAdminContent subclasses that have no data other than their type. Simply instantiate this template with the content type specified at the template argument. It is also recommended to create a template specialization for the stringRep() member, so that it returns a relevant string.


Constructor & Destructor Documentation

template<int T_contentType>
DtNoDataAdminContent< T_contentType >::DtNoDataAdminContent ( )

default constructor

template<int T_contentType>
DtNoDataAdminContent< T_contentType >::DtNoDataAdminContent ( const DtNoDataAdminContent< T_contentType > &  orig)

copy constructor

template<int T_contentType>
virtual DtNoDataAdminContent< T_contentType >::~DtNoDataAdminContent ( ) [virtual]

destructor


Member Function Documentation

template<int T_contentType>
const DtNoDataAdminContent& DtNoDataAdminContent< T_contentType >::operator= ( const DtNoDataAdminContent< T_contentType > &  orig)

assignment operator; same as copy costructor.

template<int T_contentType>
static DtAdminContent* DtNoDataAdminContent< T_contentType >::create ( ) [static]

Creator function. Returns new instance of this class.

template<int T_contentType>
virtual bool DtNoDataAdminContent< T_contentType >::init ( ) [virtual]

Call after construction.

Reimplemented from DtAdminContent.

template<int T_contentType>
virtual int DtNoDataAdminContent< T_contentType >::type ( ) const [virtual]
Returns:

Implements DtAdminContent.

template<int T_contentType>
virtual DtAdminContent* DtNoDataAdminContent< T_contentType >::clone ( ) const [virtual]

Make a copy of this content.

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

Implements DtAdminContent.

template<int T_contentType>
virtual DtString DtNoDataAdminContent< T_contentType >::stringRep ( ) const [virtual]

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.

template<int T_contentType>
virtual int DtNoDataAdminContent< T_contentType >::netRepSize ( ) const [virtual]
Returns:
Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

template<int T_contentType>
virtual bool DtNoDataAdminContent< T_contentType >::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
) [virtual]

Decodes content from buffer.

Reimplemented from DtAdminContent.

template<int T_contentType>
virtual bool DtNoDataAdminContent< T_contentType >::setToNet ( ) [virtual]

Encodes content into buffer.

Reimplemented from DtAdminContent.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)