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

class DtCeSurrender: More...

Inheritance diagram for DtCeSurrender:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtCeSurrender ()
 default constructor
 DtCeSurrender (DtReaderWriterRegistry *parentRegistry)
 real constructor
 DtCeSurrender (const DtCeSurrender &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
virtual ~DtCeSurrender ()
 destructor
DtCeSurrenderoperator= (const DtCeSurrender &orig)
 assignment operator
virtual DtSimCondExprclone (DtReaderWriterRegistry *parentRegistry=NULL)
 clone operator
virtual int type () const
 Returns DtCondExprAltitudeType (defined in condExprTypes.h).
virtual void setEntityName (const DtString &name)
 Set the entity name.
virtual const DtStringentityName () const
virtual void setModifier (const DtString &arg)
 Set the test modifier.
virtual const DtStringmodifier () const
virtual void setSurrenderTestValue (DtBoolean yesNo)
 Set the surrender value (either "true", "false") to test.
virtual DtBoolean surrenderTestValue () const
virtual DtString stringRep (int subExprIndex=DtSR_EXPR) const
 Get a readable string representation of this level of this expression.
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 expression from the network buffer.
virtual bool setToNet ()
 Fills in the network buffer (created by base class conditional expression) with the conditional expression contents.

Static Public Member Functions

static DtSimCondExprcreator ()

Protected Attributes

DtRwString myEntityName
DtRwString myModifier
DtRwBoolean mySurrenderVal

Detailed Description

class DtCeSurrender:

DtCeSurrender represents a boolean operator (true, false) test on a given entity's surrendered state. NOTE: Surrendered is valid for lifeforms only


Constructor & Destructor Documentation

default constructor

real constructor

DtCeSurrender::DtCeSurrender ( const DtCeSurrender orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

virtual DtCeSurrender::~DtCeSurrender ( ) [virtual]

destructor


Member Function Documentation

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

assignment operator

virtual DtSimCondExpr* DtCeSurrender::clone ( DtReaderWriterRegistry parentRegistry = NULL) [virtual]

clone operator

Implements DtSimCondExpr.

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

Returns DtCondExprAltitudeType (defined in condExprTypes.h).

Implements DtSimCondExpr.

virtual void DtCeSurrender::setEntityName ( const DtString name) [virtual]

Set the entity name.

virtual const DtString& DtCeSurrender::entityName ( ) const [virtual]
virtual void DtCeSurrender::setModifier ( const DtString arg) [virtual]

Set the test modifier.

If it is an empty string, checks only the specified entity. If it is the string "ANY", checks all subordinate entities to see if any of them match the test, If it is neither of the above, it requires that all specified entities match.

virtual const DtString& DtCeSurrender::modifier ( ) const [virtual]
virtual void DtCeSurrender::setSurrenderTestValue ( DtBoolean  yesNo) [virtual]

Set the surrender value (either "true", "false") to test.

virtual DtBoolean DtCeSurrender::surrenderTestValue ( ) const [virtual]
virtual DtString DtCeSurrender::stringRep ( int  subExprIndex = DtSR_EXPR) const [virtual]

Get a readable string representation of this level of this expression.

The subExprIndex argument indicates which stringRep to get if this expression can have sub-expressions. Since a DtCeSurrender has no sub-expressions, it only returns a string representation if passed an index of DtSimCondExpr::DtSR_EXPR.

See the documentation for DtSimCondExpr::stringRep for more information.

Implements DtSimCondExpr.

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

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

Reimplemented from DtSimCondExpr.

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

Fills in the expression from the network buffer.

Reimplemented from DtSimCondExpr.

virtual bool DtCeSurrender::setToNet ( ) [virtual]

Fills in the network buffer (created by base class conditional expression) with the conditional expression contents.

Reimplemented from DtSimCondExpr.

static DtSimCondExpr* DtCeSurrender::creator ( ) [static]

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)