VgRoutingModule::VgIRoutingNode Interface Reference

Inheritance diagram for VgRoutingModule::VgIRoutingNode:

Public Member Functions
virtual bool	operator== (const VgIRoutingNode &pOther) const =0
virtual bool	hasPosition () const =0
virtual const VgEngine::VgPosition &	getPosition () const =0
virtual bool	hasRoutePosition () const =0
virtual const VgEngine::VgPosition &	getRoutePosition () const =0
virtual bool	hasPoiID () const =0
virtual const std::string &	getPoiID () const =0
virtual const std::string &	getLayerName () const =0
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	VgReferenced (const VgReferenced &pThis)
virtual	~VgReferenced ()
VgReferenced &	operator= (const VgReferenced &pThis)
void	ref () const
int	unref () const
int	getNbReferences () const

Protected Member Functions
	VgIRoutingNode ()
virtual	~VgIRoutingNode ()

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences

Detailed Description

This class is an opaque pointer class to routing nodes from the routing module. You can't instanciate this class, only the routing module can. To get an instance of routing node you can call VgIRoutingSolver::getRoutingNode

Constructor & Destructor Documentation

VgRoutingModule::VgIRoutingNode::VgIRoutingNode ( )

inlineprotected

virtual VgRoutingModule::VgIRoutingNode::~VgIRoutingNode ( )

inlineprotectedvirtual

Member Function Documentation

virtual const std::string& VgRoutingModule::VgIRoutingNode::getLayerName ( ) const

pure virtual

Allows to query routing node layername

Returns

the layername of the routing node.

See also

VgRoutingModule::VgIRoutingSolver::getRoutingNode

// to obtain the layername of a poiID
VgRoutingModule::VgIRoutingSolver* lSolver = lRoutingModule->getRoutingSolver();
std::vector<std::string> lPlaceIDs;
self.mapModule->queryAllPlaceIDs(lPlaceIDs);
for (std::vector<std::string>::const_iterator lIter = lPlaceIDs.begin(), lEnd = lPlaceIDs.end(); lIter != lEnd; ++lIter)
{
    VgEngine::VgRefPtr<VgRoutingModule::VgIRoutingNode> lNode = lSolver->getRoutingNode(*lIter);
    std::string lLayerName;
    if (lNode.isValid())
    {
         lLayerName = lNode->getLayerName();
    }
    else
    {
         VgMapModule::VgPOIDescriptor lPOIDescriptor;
         if (lMapModule->queryPOIDescriptor(*lIter, lPOIDescriptor))
         {
            lLayerName = lPOIDescriptor.mLayerName;
         }
    }
}

Version

2.1.8

virtual const std::string& VgRoutingModule::VgIRoutingNode::getPoiID ( ) const

pure virtual

Allows to query routing node poiID, assumes hasPoiID returns true.

Returns

the poiID of the routing node.

See also

VgRoutingModule::VgIRoutingNode::hasPoiID

VgRoutingModule::VgIRoutingSolver::getRoutingNode

Version

2.1.8

virtual const VgEngine::VgPosition& VgRoutingModule::VgIRoutingNode::getPosition ( ) const

pure virtual

Allows to query the position with which the VgIRoutingNode was created.

Returns

the position that was passed into to getRoutingNode.

See also

VgRoutingModule::VgIRoutingNode::hasRoutePosition

VgRoutingModule::VgIRoutingSolver::getRoutingNode

Version

2.1.8

virtual const VgEngine::VgPosition& VgRoutingModule::VgIRoutingNode::getRoutePosition ( ) const

pure virtual

Allows to query routing node's position. This position is on the routing network, and might not be the same as was used to get the routing node. The altitude is 0, and the SRS will be the Scene SRS.

Returns

the position on the routing network as a function of the VgIRoutingNodeParameters

See also

VgRoutingModule::VgIRoutingNode::hasRoutePosition

VgRoutingModule::VgIRoutingSolver::getRoutingNode

Version

2.1.8

virtual bool VgRoutingModule::VgIRoutingNode::hasPoiID ( ) const

pure virtual

Allows to query if the routing node has a known location

Returns

true if getPoiID will return a valid POI ID

See also

VgRoutingModule::VgIRoutingNode::getPoiID

Version

2.1.8

virtual bool VgRoutingModule::VgIRoutingNode::hasPosition ( ) const

pure virtual

Allows to query the position with which the VgIRoutingNode was created.

Returns

true if getPosition will return a valid position

See also

VgRoutingModule::VgIRoutingNode::getPosition

Version

2.1.8

virtual bool VgRoutingModule::VgIRoutingNode::hasRoutePosition ( ) const

pure virtual

Allows to query the position of the routing node on the network

Returns

true if getRoutePosition will return a valid position

See also

VgRoutingModule::VgIRoutingNode::getRoutePosition

Version

2.1.8

virtual bool VgRoutingModule::VgIRoutingNode::operator== ( const VgIRoutingNode &  pOther ) const

pure virtual

Operator to compare two routing nodes for equality

---

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

• VgIRoutingNode.h