VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes
DtSetChannelRequest Class Reference

DtSetChannelRequest is used to specify a channel for an entity. More...

Inheritance diagram for DtSetChannelRequest:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSetChannelRequest ()
 default constructor
 DtSetChannelRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a request 'put' itself, the writeName will preface it.
 DtSetChannelRequest (const DtString &writeName, const DtSetChannelRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtSetChannelRequestoperator= (const DtSetChannelRequest &orig)
 assignment operator
virtual ~DtSetChannelRequest ()
virtual int type () const
 Returns DtSetChannelRequestType.
virtual DtSetDataRequestclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 Creates a copy of the request.
virtual DtString stringRep () const
 Get a readable string representation of this setDataRequest.
virtual DtU32 newChannel () const
virtual void setNewChannel (DtU32 chan)
virtual int netRepSize () const
 Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Fills in the task from the network buffer.
virtual bool setToNet ()
 Fills in the network buffer (created by base class simTask) with the task contents.

Static Public Member Functions

static DtSetDataRequestcreator ()

Protected Attributes

DtRwInt myNewChannel

Detailed Description

DtSetChannelRequest is used to specify a channel for an entity.

It inherits read/writableness from DtSetDataRequest, and includes the name of the entity to target.

set-data-request-type: DtSetChannelRequestType


Constructor & Destructor Documentation

default constructor

DtSetChannelRequest::DtSetChannelRequest ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = 0 
)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetChannelRequest::DtSetChannelRequest ( const DtString writeName,
const DtSetChannelRequest orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor


Member Function Documentation

const DtSetChannelRequest& DtSetChannelRequest::operator= ( const DtSetChannelRequest orig)

assignment operator

virtual int DtSetChannelRequest::type ( ) const [virtual]

Returns DtSetChannelRequestType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetChannelRequest::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetChannelRequest::stringRep ( ) const [virtual]

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual DtU32 DtSetChannelRequest::newChannel ( ) const [virtual]
virtual void DtSetChannelRequest::setNewChannel ( DtU32  chan) [virtual]
virtual int DtSetChannelRequest::netRepSize ( ) const [virtual]

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

virtual bool DtSetChannelRequest::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
) [virtual]

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetChannelRequest::setToNet ( ) [virtual]

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.


Member Data Documentation


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)