DtIfSetSpatialSubdivisionConfiguration Class Reference

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

Inheritance diagram for DtIfSetSpatialSubdivisionConfiguration:

Public Member Functions
	DtIfSetSpatialSubdivisionConfiguration ()
	default constructor
	DtIfSetSpatialSubdivisionConfiguration (const DtIfSetSpatialSubdivisionConfiguration &orig)
	copy constructor
const DtIfSetSpatialSubdivisionConfiguration &	operator= (const DtIfSetSpatialSubdivisionConfiguration &orig)
	assignment operator
virtual	~DtIfSetSpatialSubdivisionConfiguration ()
virtual int	type () const
	Returns DtSetSpatialSubdivisionConfigurationType, defined in msgTypes.h.
virtual DtSimInterfaceContent *	clone () const
	Returns newly created copy of this object.
virtual void	setSpatialSubdivisionType (DtSpatialSubdivisionType type)
	Type of spatial subdivision type for which we want to set its 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 DtNetIfSetSpatialSubdivisionConfiguration 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 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 DtSimInterfaceContent *	creator ()
	Returns a new instance of this class.
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()

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

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory

Detailed Description

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

Content-Type: DtQuerySpatialSubdivisionConfigurationType

Constructor & Destructor Documentation

DtIfSetSpatialSubdivisionConfiguration::DtIfSetSpatialSubdivisionConfiguration

(

)

default constructor

DtIfSetSpatialSubdivisionConfiguration::DtIfSetSpatialSubdivisionConfiguration

(

const DtIfSetSpatialSubdivisionConfiguration &

orig

)

copy constructor

virtual DtIfSetSpatialSubdivisionConfiguration::~DtIfSetSpatialSubdivisionConfiguration ( )

virtual

Member Function Documentation

const DtIfSetSpatialSubdivisionConfiguration& DtIfSetSpatialSubdivisionConfiguration::operator=

(

const DtIfSetSpatialSubdivisionConfiguration &

orig

)

assignment operator

virtual int DtIfSetSpatialSubdivisionConfiguration::type ( ) const

virtual

Returns DtSetSpatialSubdivisionConfigurationType, defined in msgTypes.h.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfSetSpatialSubdivisionConfiguration::clone ( ) const

virtual

Returns newly created copy of this object.

Implements DtSimInterfaceContent.

virtual void DtIfSetSpatialSubdivisionConfiguration::setSpatialSubdivisionType ( DtSpatialSubdivisionType  type )

virtual

Type of spatial subdivision type for which we want to set its configuration.

Spatial subdivision types are defined in spatialSubdivisionTypes.h.

virtual DtSpatialSubdivisionType DtIfSetSpatialSubdivisionConfiguration::spatialSubdivisionType ( ) const

virtual

virtual void DtIfSetSpatialSubdivisionConfiguration::setSpatialSubdivisionXResolution ( unsigned int  resolution )

virtual

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

virtual unsigned int DtIfSetSpatialSubdivisionConfiguration::spatialSubdivisionXResolution ( ) const

virtual

virtual void DtIfSetSpatialSubdivisionConfiguration::setSpatialSubdivisionYResolution ( unsigned int  resolution )

virtual

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

virtual unsigned int DtIfSetSpatialSubdivisionConfiguration::spatialSubdivisionYResolution ( ) const

virtual

virtual void DtIfSetSpatialSubdivisionConfiguration::setSpatialSubdivisionZResolution ( unsigned int  resolution )

virtual

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

virtual unsigned int DtIfSetSpatialSubdivisionConfiguration::spatialSubdivisionZResolution ( ) const

virtual

virtual int DtIfSetSpatialSubdivisionConfiguration::netRepSize ( ) const

virtual

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

Reimplemented from DtSimInterfaceContent.

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

virtual

Unpack network representation (contentBuffer) into this object.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSetSpatialSubdivisionConfiguration::setToNet ( )

virtual

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

Reimplemented from DtSimInterfaceContent.

virtual void DtIfSetSpatialSubdivisionConfiguration::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* DtIfSetSpatialSubdivisionConfiguration::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 DtIfSetSpatialSubdivisionConfiguration::mySpatialSubdivisionType

protected

unsigned int DtIfSetSpatialSubdivisionConfiguration::mySpatialSubdivisionXResolution

protected

unsigned int DtIfSetSpatialSubdivisionConfiguration::mySpatialSubdivisionYResolution

protected

unsigned int DtIfSetSpatialSubdivisionConfiguration::mySpatialSubdivisionZResolution

protected

---

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

• include/vrfmsgs/ifSetSpatialSubdivisionConfig.h