VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions
DtNoopCommand Class Reference

DtSimCommand which does nothing. More...

Inheritance diagram for DtNoopCommand:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtNoopCommand ()
 Default constructor.
 DtNoopCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
 Usual constructor.
 DtNoopCommand (const DtString &writeName, const DtNoopCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
virtual ~DtNoopCommand ()
 destructor
DtNoopCommandoperator= (const DtNoopCommand &orig)
 assignment operator
int type () const
virtual DtSimCommandclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString stringRep () const
 Text representation of this command.
virtual int netRepSize () const
 Returns the size in bytes of the network representation of the class.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
virtual bool setToNet ()
 Calls netRep() to create the network buffer.

Static Public Member Functions

static DtSimCommandcreator ()
 Returns a new instance of this class.

Detailed Description

DtSimCommand which does nothing.


Constructor & Destructor Documentation

Default constructor.

DtNoopCommand::DtNoopCommand ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = NULL 
)

Usual constructor.

DtNoopCommand::DtNoopCommand ( const DtString writeName,
const DtNoopCommand orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

virtual DtNoopCommand::~DtNoopCommand ( ) [virtual]

destructor


Member Function Documentation

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

assignment operator

int DtNoopCommand::type ( ) const [virtual]
Returns:
DtNoopCommandType.

Implements DtSimCommand.

virtual DtSimCommand* DtNoopCommand::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const [virtual]
Returns:
A new instance of this class, copied from the original.

Implements DtSimCommand.

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

Text representation of this command.

Implements DtSimCommand.

virtual int DtNoopCommand::netRepSize ( ) const [virtual]

Returns the size in bytes of the network representation of the class.

This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimCommand.

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

Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).

Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual bool DtNoopCommand::setToNet ( ) [virtual]

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

static DtSimCommand* DtNoopCommand::creator ( ) [static]

Returns a new instance of this class.


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)