VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtIfSpatialSubdivisionConfiguration Class Reference

Instances of this class are the interface message content used to publish the spatial subdivision configuration for a given simulation back-end for its spatial subdivision configuration. More...

Inheritance diagram for DtIfSpatialSubdivisionConfiguration:
Inheritance graph
[legend]

Public Member Functions

 DtIfSpatialSubdivisionConfiguration ()
 default constructor
 DtIfSpatialSubdivisionConfiguration (const DtIfSpatialSubdivisionConfiguration &orig)
 copy constructor
const
DtIfSpatialSubdivisionConfiguration
operator= (const DtIfSpatialSubdivisionConfiguration &orig)
 assignment operator
virtual ~DtIfSpatialSubdivisionConfiguration ()
virtual int type () const
 Returns DtSpatialSubdivisionConfigurationType, defined in msgTypes.h.
virtual DtSimInterfaceContentclone () const
 Returns newly created copy of this object.
virtual void setSpatialSubdivisionType (DtSpatialSubdivisionType type)
 Type of spatial subdivision type for this configuration.
virtual DtSpatialSubdivisionType spatialSubdivisionType () const
virtual void setSpatialSubdivisionXResolution (unsigned int resolution)
 Resolution of spatial subdivision cell aligned along X axis, in terrain database coordinates.
virtual unsigned int spatialSubdivisionXResolution () const
virtual void setSpatialSubdivisionYResolution (unsigned int resolution)
 Resolution of spatial subdivision cell aligned along Y axis, in terrain database coordinates.
virtual unsigned int spatialSubdivisionYResolution () const
virtual void setSpatialSubdivisionZResolution (unsigned int resolution)
 Resolution of spatial subdivision cell aligned along Z axis, in terrain database coordinates.
virtual unsigned int spatialSubdivisionZResolution () const
virtual int netRepSize () const
 Returns size of network representation of this object, in bytes.
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Unpack network representation (contentBuffer) into this object.
virtual bool setToNet ()
 Package this object's data into a network format (a DtNetIfSpatialSubdivisionConfiguration struct).
virtual void printDataToString (DtString &str)
 Human readable representation of this object's data (used for debugging purposes, and in applications such as vrfMsgDump).
- Public Member Functions inherited from DtIfServerRequestResponse
 DtIfServerRequestResponse ()
 default constructor
 DtIfServerRequestResponse (const DtIfServerRequestResponse &orig)
 copy constructor
const DtIfServerRequestResponseoperator= (const DtIfServerRequestResponse &orig)
 assignment operator
virtual ~DtIfServerRequestResponse ()
virtual void setResponseId (const DtU32 &id)
const DtU32 & responseId () const
- Public Member Functions inherited from DtSimInterfaceContent
virtual ~DtSimInterfaceContent ()
virtual bool update (const DtSimInterfaceContent *data)
virtual char * netRep ()
virtual void setUseSessionId (bool yesNo)
virtual bool useSessionId () const

Static Public Member Functions

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

Protected Attributes

DtSpatialSubdivisionType mySpatialSubdivisionType
unsigned int mySpatialSubdivisionXResolution
unsigned int mySpatialSubdivisionYResolution
unsigned int mySpatialSubdivisionZResolution
- Protected Attributes inherited from DtIfServerRequestResponse
DtU32 myResponseId
- Protected Attributes inherited from DtSimInterfaceContent
char * myNetRep
bool myUseSessionId

Additional Inherited Members

- Protected Member Functions inherited from DtSimInterfaceContent
 DtSimInterfaceContent ()
 DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContentoperator= (const DtSimInterfaceContent &orig)
virtual char * createNetworkBuffer ()
- Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactorymyFactory

Detailed Description

Instances of this class are the interface message content used to publish the spatial subdivision configuration for a given simulation back-end for its spatial subdivision configuration.

Content-Type: DtQuerySpatialSubdivisionConfigurationType

Constructor & Destructor Documentation

DtIfSpatialSubdivisionConfiguration::DtIfSpatialSubdivisionConfiguration ( )

default constructor

DtIfSpatialSubdivisionConfiguration::DtIfSpatialSubdivisionConfiguration ( const DtIfSpatialSubdivisionConfiguration orig)

copy constructor

virtual DtIfSpatialSubdivisionConfiguration::~DtIfSpatialSubdivisionConfiguration ( )
virtual

Member Function Documentation

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

assignment operator

virtual int DtIfSpatialSubdivisionConfiguration::type ( ) const
virtual

Returns DtSpatialSubdivisionConfigurationType, defined in msgTypes.h.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfSpatialSubdivisionConfiguration::clone ( ) const
virtual

Returns newly created copy of this object.

Implements DtSimInterfaceContent.

virtual void DtIfSpatialSubdivisionConfiguration::setSpatialSubdivisionType ( DtSpatialSubdivisionType  type)
virtual

Type of spatial subdivision type for this configuration.

Spatial subdivision types are defined in spatialSubdivisionTypes.h.

virtual DtSpatialSubdivisionType DtIfSpatialSubdivisionConfiguration::spatialSubdivisionType ( ) const
virtual
virtual void DtIfSpatialSubdivisionConfiguration::setSpatialSubdivisionXResolution ( unsigned int  resolution)
virtual

Resolution of spatial subdivision cell aligned along X axis, in terrain database coordinates.

virtual unsigned int DtIfSpatialSubdivisionConfiguration::spatialSubdivisionXResolution ( ) const
virtual
virtual void DtIfSpatialSubdivisionConfiguration::setSpatialSubdivisionYResolution ( unsigned int  resolution)
virtual

Resolution of spatial subdivision cell aligned along Y axis, in terrain database coordinates.

virtual unsigned int DtIfSpatialSubdivisionConfiguration::spatialSubdivisionYResolution ( ) const
virtual
virtual void DtIfSpatialSubdivisionConfiguration::setSpatialSubdivisionZResolution ( unsigned int  resolution)
virtual

Resolution of spatial subdivision cell aligned along Z axis, in terrain database coordinates.

virtual unsigned int DtIfSpatialSubdivisionConfiguration::spatialSubdivisionZResolution ( ) const
virtual
virtual int DtIfSpatialSubdivisionConfiguration::netRepSize ( ) const
virtual

Returns size of network representation of this object, in bytes.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSpatialSubdivisionConfiguration::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
)
virtual

Unpack network representation (contentBuffer) into this object.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSpatialSubdivisionConfiguration::setToNet ( )
virtual

Package this object's data into a network format (a DtNetIfSpatialSubdivisionConfiguration struct).

Reimplemented from DtSimInterfaceContent.

virtual void DtIfSpatialSubdivisionConfiguration::printDataToString ( DtString str)
virtual

Human readable representation of this object's data (used for debugging purposes, and in applications such as vrfMsgDump).

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfSpatialSubdivisionConfiguration::creator ( )
static

Returns a new instance of this class.

This function is registered with the DtInterfaceContentFactory with a key returned by the type() member function.

Member Data Documentation

DtSpatialSubdivisionType DtIfSpatialSubdivisionConfiguration::mySpatialSubdivisionType
protected
unsigned int DtIfSpatialSubdivisionConfiguration::mySpatialSubdivisionXResolution
protected
unsigned int DtIfSpatialSubdivisionConfiguration::mySpatialSubdivisionYResolution
protected
unsigned int DtIfSpatialSubdivisionConfiguration::mySpatialSubdivisionZResolution
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)