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

File: setRestore.h. More...

Inheritance diagram for DtSetRestoreRequest:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtSetRestoreRequest ()
 default constructor
 DtSetRestoreRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a request 'put' itself, the writeName will preface it.
 DtSetRestoreRequest (const DtString &writeName, const DtSetRestoreRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtSetRestoreRequestoperator= (const DtSetRestoreRequest &orig)
 assignment operator
virtual ~DtSetRestoreRequest ()
virtual int type () const
 Returns DtSetRestoreRequestType.
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 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 ()

Detailed Description

File: setRestore.h.

Class: DtSetRestoreRequest DtSetRestoreRequest is used to force an entity to the resource levels specified for that entity type in the parameter database and not destroyed (or full health, for an aggregate).

It inherits read/writableness from DtSetDataRequest, and has no message- specific data.

set-data-request-type: DtSetRestoreRequestType

parameters: None.


Constructor & Destructor Documentation

default constructor

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

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

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

copy constructor


Member Function Documentation

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

assignment operator

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

Returns DtSetRestoreRequestType.

Implements DtSetDataRequest.

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

Creates a copy of the request.

Implements DtSetDataRequest.

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

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

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

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

Reimplemented from DtSetDataRequest.

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

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetRestoreRequest::setToNet ( ) [virtual]

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

Reimplemented from DtSetDataRequest.


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)