DtIfRequestTerrainProfileInformation Class Reference

Interface content for requesting terrain profile information or cancelling a current request. Once the request is made, either a full or partial responses will be give back (depending on the setting).

Inheritance diagram for DtIfRequestTerrainProfileInformation:

Public Member Functions
	DtIfRequestTerrainProfileInformation ()
	DtIfRequestTerrainProfileInformation (const DtIfRequestTerrainProfileInformation &orig)
const DtIfRequestTerrainProfileInformation &	operator= (const DtIfRequestTerrainProfileInformation &orig)
virtual	~DtIfRequestTerrainProfileInformation ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual void	setRequestId (int)
virtual int	requestId () const
virtual void	setSendPartialInformation (bool)
virtual bool	sendPartialInformation () const
virtual void	setPoints (const std::vector< DtVector > &)
virtual const std::vector < DtVector > &	points () const
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
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 ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Member Functions
virtual int	sizeOfContent () const
virtual char *	setUncompressedToNet (char *buffer) const
virtual const char *	setUncompressedFromNet (const char *contentBuffer)
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()

Protected Attributes
int	myRequestId
bool	mySendPartialInformation
std::vector< DtVector >	myPoints
DtU32	myUncompressedSize
DtU32	myCompressedSize
bool	myCompressed
const char *	myCompressedBuffer
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfRequestTerrainProfileInformation::DtIfRequestTerrainProfileInformation

(

)

default constructor

DtIfRequestTerrainProfileInformation::DtIfRequestTerrainProfileInformation

(

const DtIfRequestTerrainProfileInformation &

orig

)

copy constructor

virtual DtIfRequestTerrainProfileInformation::~DtIfRequestTerrainProfileInformation ( )

virtual

Member Function Documentation

const DtIfRequestTerrainProfileInformation& DtIfRequestTerrainProfileInformation::operator=

(

const DtIfRequestTerrainProfileInformation &

orig

)

assignment operator

virtual int DtIfRequestTerrainProfileInformation::type ( ) const

virtual

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfRequestTerrainProfileInformation::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual int DtIfRequestTerrainProfileInformation::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestTerrainProfileInformation::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfRequestTerrainProfileInformation::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfRequestTerrainProfileInformation::creator ( )

static

virtual void DtIfRequestTerrainProfileInformation::setRequestId ( int  )

virtual

virtual int DtIfRequestTerrainProfileInformation::requestId ( ) const

virtual

virtual void DtIfRequestTerrainProfileInformation::setSendPartialInformation ( bool  )

virtual

When partial information is requested, a series of responses will be sent containing the information that has been discovered since the last check. The response will be in the form of a DtIfIntersectionInformationResponse where the user data of each information response is the index of the terrain profile request satisfied with the response.

virtual bool DtIfRequestTerrainProfileInformation::sendPartialInformation ( ) const

virtual

virtual void DtIfRequestTerrainProfileInformation::setPoints ( const std::vector< DtVector > &  )

virtual

virtual const std::vector<DtVector>& DtIfRequestTerrainProfileInformation::points ( ) const

virtual

virtual int DtIfRequestTerrainProfileInformation::sizeOfContent ( ) const

protectedvirtual

virtual char* DtIfRequestTerrainProfileInformation::setUncompressedToNet ( char *  buffer ) const

protectedvirtual

virtual const char* DtIfRequestTerrainProfileInformation::setUncompressedFromNet ( const char *  contentBuffer )

protectedvirtual

Member Data Documentation

int DtIfRequestTerrainProfileInformation::myRequestId

protected

bool DtIfRequestTerrainProfileInformation::mySendPartialInformation

protected

std::vector<DtVector> DtIfRequestTerrainProfileInformation::myPoints

protected

Default is true.

DtU32 DtIfRequestTerrainProfileInformation::myUncompressedSize

mutableprotected

DtU32 DtIfRequestTerrainProfileInformation::myCompressedSize

mutableprotected

bool DtIfRequestTerrainProfileInformation::myCompressed

mutableprotected

const char* DtIfRequestTerrainProfileInformation::myCompressedBuffer

mutableprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmsgs/ifRequestTerrainProfileInformation.h