DtIfComputeRoute Class Reference

Inheritance diagram for DtIfComputeRoute:

Public Member Functions
	DtIfComputeRoute ()
	default constructor More...
	DtIfComputeRoute (const DtIfComputeRoute &orig)
	copy constructor More...
const DtIfComputeRoute &	operator= (const DtIfComputeRoute &orig)
	assignment operator More...
virtual	~DtIfComputeRoute ()
	destructor More...
virtual unsigned long	requestId () const
	Set/get the request Id for the message. More...
virtual void	setRequestId (unsigned long requestId)
virtual void	setObjectName (const DtString &objectName)
	Set/get the object name of the route to create. More...
virtual const DtString &	objectName () const
virtual void	setForceType (const DtForceType forceType)
	Set/get the force type of the route to create. More...
virtual DtForceType	forceType () const
virtual void	setOverlay (const DtString &overlay)
	Set/get the overlay name of the route. More...
virtual const DtString &	overlay () const
virtual void	setObjectLabel (const DtString &objectLabel)
	Set/get the object label of the route. More...
virtual const DtString &	objectLabel () const
virtual const DtVector &	startPoint () const
virtual void	setStartPoint (const DtVector &)
virtual void	setExtendedLabels (const std::map< int, DtString > &extendedLabels)
	Set/get the object label of the vrf object to create. More...
virtual const std::map< int, DtString > &	extendedLabels () const
virtual const DtVector &	endPoint () const
virtual void	setEndPoint (const DtVector &)
virtual const std::vector < DtString > &	obstacleTypes () const
virtual void	setObstacleTypes (const std::vector< DtString > &)
virtual void	addObstacleType (const DtString &)
virtual const std::vector < DtString > &	pathTypes () const
virtual void	setPathTypes (const std::vector< DtString > &)
virtual void	addPathType (const DtString &)
virtual bool	cancel () const
virtual void	setCancel (bool)
virtual int	type () const
virtual DtIfComputeRoute *	clone () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
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
DtString	myObjectName
DtForceType	myForceType
DtString	myOverlay
DtString	myObjectLabel
DtVector	myStartPoint
DtVector	myEndPoint
std::vector< DtString >	myObstacleTypes
std::vector< DtString >	myPathTypes
std::map< int, DtString >	myExtendedLabels
bool	myCancelFlag
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

Constructor & Destructor Documentation

DtIfComputeRoute::DtIfComputeRoute

(

)

default constructor

DtIfComputeRoute::DtIfComputeRoute

(

const DtIfComputeRoute &

orig

)

copy constructor

virtual DtIfComputeRoute::~DtIfComputeRoute ( )

virtual

destructor

Member Function Documentation

const DtIfComputeRoute& DtIfComputeRoute::operator=

(

const DtIfComputeRoute &

orig

)

assignment operator

virtual unsigned long DtIfComputeRoute::requestId ( ) const

virtual

Set/get the request Id for the message.

Request Id is used to associate this message with the response message.

virtual void DtIfComputeRoute::setRequestId ( unsigned long  requestId )

virtual

virtual void DtIfComputeRoute::setObjectName ( const DtString &  objectName )

virtual

Set/get the object name of the route to create.

Note that if the object name length is > 255 characters, it will be trimmed to 255 characters

virtual const DtString& DtIfComputeRoute::objectName ( ) const

virtual

virtual void DtIfComputeRoute::setForceType ( const DtForceType  forceType )

virtual

Set/get the force type of the route to create.

virtual DtForceType DtIfComputeRoute::forceType ( ) const

virtual

virtual void DtIfComputeRoute::setOverlay ( const DtString &  overlay )

virtual

Set/get the overlay name of the route.

virtual const DtString& DtIfComputeRoute::overlay ( ) const

virtual

virtual void DtIfComputeRoute::setObjectLabel ( const DtString &  objectLabel )

virtual

Set/get the object label of the route.

virtual const DtString& DtIfComputeRoute::objectLabel ( ) const

virtual

virtual const DtVector& DtIfComputeRoute::startPoint ( ) const

virtual

virtual void DtIfComputeRoute::setStartPoint ( const DtVector &  )

virtual

virtual void DtIfComputeRoute::setExtendedLabels ( const std::map< int, DtString > &  extendedLabels )

virtual

Set/get the object label of the vrf object to create.

virtual const std::map<int, DtString>& DtIfComputeRoute::extendedLabels ( ) const

virtual

virtual const DtVector& DtIfComputeRoute::endPoint ( ) const

virtual

virtual void DtIfComputeRoute::setEndPoint ( const DtVector &  )

virtual

virtual const std::vector<DtString>& DtIfComputeRoute::obstacleTypes ( ) const

virtual

virtual void DtIfComputeRoute::setObstacleTypes ( const std::vector< DtString > &  )

virtual

virtual void DtIfComputeRoute::addObstacleType ( const DtString &  )

virtual

virtual const std::vector<DtString>& DtIfComputeRoute::pathTypes ( ) const

virtual

virtual void DtIfComputeRoute::setPathTypes ( const std::vector< DtString > &  )

virtual

virtual void DtIfComputeRoute::addPathType ( const DtString &  )

virtual

virtual bool DtIfComputeRoute::cancel ( ) const

virtual

virtual void DtIfComputeRoute::setCancel ( bool  )

virtual

virtual int DtIfComputeRoute::type ( ) const

virtual

Implements DtSimInterfaceContent.

virtual DtIfComputeRoute* DtIfComputeRoute::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual int DtIfComputeRoute::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfComputeRoute::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfComputeRoute::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfComputeRoute::creator ( )

static

Member Data Documentation

DtU32 DtIfComputeRoute::myRequestId

protected

DtString DtIfComputeRoute::myObjectName

protected

DtForceType DtIfComputeRoute::myForceType

protected

DtString DtIfComputeRoute::myOverlay

protected

DtString DtIfComputeRoute::myObjectLabel

protected

DtVector DtIfComputeRoute::myStartPoint

protected

DtVector DtIfComputeRoute::myEndPoint

protected

std::vector<DtString> DtIfComputeRoute::myObstacleTypes

protected

std::vector<DtString> DtIfComputeRoute::myPathTypes

protected

std::map<int, DtString> DtIfComputeRoute::myExtendedLabels

protected

bool DtIfComputeRoute::myCancelFlag

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfmsgs/ifComputeRoute.h