DtIfRequestIntersectionInformation Class Reference

Interface content for requesting intersection information. More...

Inheritance diagram for DtIfRequestIntersectionInformation:

Public Types
enum	IntersectionRequestFlag {   ClosestIntersection = 0x00000001, SoilType = 0x00000002, AllIntersectionsThroughPoint = 0x00000004, IntersectVectors = 0x00000008,   LineOfSight = 0x00000010, Default = AllIntersectionsThroughPoint | SoilType | IntersectVectors }
	For the flags, if closest intersection is supplied, and intersect vectors is supplied, if there is an intersection for both a polygon and a vector at the same point, the vector intersection information for soil type (if specified) will be returned. More...
typedef std::vector< DtVector >	IntersectionRequest

Public Member Functions
	DtIfRequestIntersectionInformation ()
	default constructor
	DtIfRequestIntersectionInformation (const DtIfRequestIntersectionInformation &orig)
	copy constructor
const DtIfRequestIntersectionInformation &	operator= (const DtIfRequestIntersectionInformation &orig)
	assignment operator
virtual	~DtIfRequestIntersectionInformation ()
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 (unsigned long)
	Request id. This will be used by requestor to match appropriate response.
unsigned long	requestId () const
virtual void	addIntersectionRequest (const DtVector &from, const DtVector &to)
	Then the request is added it is added as a series of the two points to the intersection request vector.
virtual void	clearIntersectionRequests ()
const IntersectionRequest &	intersectionRequests () const
virtual void	setRequestFlags (int)
	Flag for the type of information to return.
IntersectionRequestFlag	requestFlags ()
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 Attributes
DtU32	myRequestId
IntersectionRequest	myIntersectionRequests
int	myRequestFlag
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
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Detailed Description

Interface content for requesting intersection information.

Note that all point requests must be supplied in geocentric

Member Typedef Documentation

typedef std::vector<DtVector> DtIfRequestIntersectionInformation::IntersectionRequest

Member Enumeration Documentation

enum DtIfRequestIntersectionInformation::IntersectionRequestFlag

For the flags, if closest intersection is supplied, and intersect vectors is supplied, if there is an intersection for both a polygon and a vector at the same point, the vector intersection information for soil type (if specified) will be returned.

The same is true for all intersections through point

If LineOfSight is requested, if there is line of sight to the target point there will be no result set, else there will be a result set of 1 point which is where the line of sight is blocked

Enumerator:

ClosestIntersection
SoilType
AllIntersectionsThroughPoint
IntersectVectors
LineOfSight
Default

Constructor & Destructor Documentation

DtIfRequestIntersectionInformation::DtIfRequestIntersectionInformation

(

)

default constructor

DtIfRequestIntersectionInformation::DtIfRequestIntersectionInformation

(

const DtIfRequestIntersectionInformation &

orig

)

copy constructor

virtual DtIfRequestIntersectionInformation::~DtIfRequestIntersectionInformation ( )

virtual

Member Function Documentation

const DtIfRequestIntersectionInformation& DtIfRequestIntersectionInformation::operator=

(

const DtIfRequestIntersectionInformation &

orig

)

assignment operator

virtual int DtIfRequestIntersectionInformation::type ( ) const

virtual

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfRequestIntersectionInformation::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual int DtIfRequestIntersectionInformation::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestIntersectionInformation::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfRequestIntersectionInformation::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfRequestIntersectionInformation::creator ( )

static

virtual void DtIfRequestIntersectionInformation::setRequestId ( unsigned  long )

virtual

Request id. This will be used by requestor to match appropriate response.

unsigned long DtIfRequestIntersectionInformation::requestId ( ) const

inline

virtual void DtIfRequestIntersectionInformation::addIntersectionRequest ( const DtVector &  from, const DtVector &  to  )

virtual

Then the request is added it is added as a series of the two points to the intersection request vector.

The number of requests is the size of the vector divided by 2

virtual void DtIfRequestIntersectionInformation::clearIntersectionRequests ( )

virtual

const IntersectionRequest& DtIfRequestIntersectionInformation::intersectionRequests ( ) const

inline

virtual void DtIfRequestIntersectionInformation::setRequestFlags ( int  )

virtual

Flag for the type of information to return.

See enumeration for types. Default is closest intersection and soil type

IntersectionRequestFlag DtIfRequestIntersectionInformation::requestFlags ( )

inline

Member Data Documentation

DtU32 DtIfRequestIntersectionInformation::myRequestId

protected

IntersectionRequest DtIfRequestIntersectionInformation::myIntersectionRequests

protected

int DtIfRequestIntersectionInformation::myRequestFlag

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfmsgs/ifRequestIntersectionInformation.h