inet::Topology::Node Class Reference

Supporting class for Topology, represents a node in the graph. More...

#include <Topology.h>

Inheritance diagram for inet::Topology::Node:

Public Member Functions
	Node (int moduleId=-1)
	Constructor. More...
virtual	~Node ()
Node attributes: weight, enabled state, correspondence to modules.
int	getModuleId () const
	Returns the ID of the network module to which this node corresponds. More...
cModule *	getModule () const
	Returns the pointer to the network module to which this node corresponds. More...
double	getWeight () const
	Returns the weight of this node. More...
void	setWeight (double d)
	Sets the weight of this node. More...
bool	isEnabled () const
	Returns true of this node is enabled. More...
void	enable ()
	Enable this node. More...
void	disable ()
	Disable this node. More...
Node connectivity.
int	getNumInLinks () const
	Returns the number of incoming links to this graph node. More...
LinkIn *	getLinkIn (int i)
	Returns ith incoming link of graph node. More...
int	getNumOutLinks () const
	Returns the number of outgoing links from this graph node. More...
LinkOut *	getLinkOut (int i)
	Returns ith outgoing link of graph node. More...
Result of shortest path extraction.
double	getDistanceToTarget () const
	Returns the distance of this node to the target node. More...
int	getNumPaths () const
	Returns the number of shortest paths towards the target node. More...
LinkOut *	getPath (int) const
	Returns the next link in the ith shortest paths towards the target node. More...

Protected Attributes
int	moduleId
double	weight
bool	enabled
std::vector< Link * >	inLinks
std::vector< Link * >	outLinks
double	dist
Link *	outPath

Friends
class	Topology

Detailed Description

Supporting class for Topology, represents a node in the graph.

Constructor & Destructor Documentation

inet::Topology::Node::Node ( int  moduleId = -1 )

inline

Constructor.

{ this->moduleId = moduleId; weight = 0; enabled = true; dist = INFINITY; outPath = nullptr; }

virtual inet::Topology::Node::~Node ( )

inlinevirtual

Reimplemented in inet::NetworkConfiguratorBase::Node, inet::L2NetworkConfigurator::Node, and inet::IPv4NetworkConfigurator::Node.

{}

Member Function Documentation

void inet::Topology::Node::disable ( )

inline

Disable this node.

This has significance with the shortest path finder methods of Topology.

{ enabled = false; }

void inet::Topology::Node::enable ( )

inline

Enable this node.

This has significance with the shortest path finder methods of Topology.

{ enabled = true; }

double inet::Topology::Node::getDistanceToTarget ( ) const

inline

Returns the distance of this node to the target node.

{ return dist; }

Topology::LinkIn * inet::Topology::Node::getLinkIn

(

int

i

)

Returns ith incoming link of graph node.

Referenced by inet::IPv4NetworkConfigurator::addStaticRoutes(), inet::Topology::calculateWeightedSingleShortestPathsTo(), and inet::NetworkConfiguratorBase::dumpTopology().

{
    if (i < 0 || i >= (int)inLinks.size())
        throw cRuntimeError("Topology::Node::getLinkIn: invalid link index %d", i);
    return (Topology::LinkIn *)inLinks[i];
}

Topology::LinkOut * inet::Topology::Node::getLinkOut

(

int

i

)

Returns ith outgoing link of graph node.

Referenced by inet::STPTester::dfsVisit(), inet::NetworkConfiguratorBase::dumpTopology(), inet::NetworkConfiguratorBase::extractDeviceNeighbors(), inet::NetworkConfiguratorBase::extractTopology(), inet::L2NetworkConfigurator::findLinkOut(), and inet::NetworkConfiguratorBase::findLinkOut().

{
    if (i < 0 || i >= (int)outLinks.size())
        throw cRuntimeError("Topology::Node::getLinkOut: invalid index %d", i);
    return (Topology::LinkOut *)outLinks[i];
}

cModule* inet::Topology::Node::getModule ( ) const

inline

Returns the pointer to the network module to which this node corresponds.

Referenced by inet::IPv4NetworkConfigurator::addStaticRoutes(), inet::IPv4NetworkConfigurator::configureRoutingTable(), inet::Topology::extractFromNetwork(), inet::L2NetworkConfigurator::extractTopology(), inet::NetworkConfiguratorBase::extractTopology(), and inet::STPTester::isForwarding().

{ return getSimulation()->getModule(moduleId); }

int inet::Topology::Node::getModuleId ( ) const

inline

Returns the ID of the network module to which this node corresponds.

{ return moduleId; }

int inet::Topology::Node::getNumInLinks ( ) const

inline

Returns the number of incoming links to this graph node.

Referenced by inet::IPv4NetworkConfigurator::addStaticRoutes(), inet::Topology::calculateWeightedSingleShortestPathsTo(), and inet::NetworkConfiguratorBase::dumpTopology().

{ return inLinks.size(); }

int inet::Topology::Node::getNumOutLinks ( ) const

inline

Returns the number of outgoing links from this graph node.

Referenced by inet::STPTester::dfsVisit(), inet::NetworkConfiguratorBase::dumpTopology(), inet::NetworkConfiguratorBase::extractDeviceNeighbors(), inet::NetworkConfiguratorBase::extractTopology(), inet::L2NetworkConfigurator::findLinkOut(), and inet::NetworkConfiguratorBase::findLinkOut().

{ return outLinks.size(); }

int inet::Topology::Node::getNumPaths ( ) const

inline

Returns the number of shortest paths towards the target node.

(There may be several paths with the same length.)

Referenced by inet::GenericNetworkConfigurator::addStaticRoutes(), and inet::IPv4NetworkConfigurator::addStaticRoutes().

{ return outPath ? 1 : 0; }

LinkOut* inet::Topology::Node::getPath ( int  ) const

inline

Returns the next link in the ith shortest paths towards the target node.

(There may be several paths with the same length.)

Referenced by inet::GenericNetworkConfigurator::addStaticRoutes(), and inet::IPv4NetworkConfigurator::addStaticRoutes().

{ return (LinkOut *)outPath; }

double inet::Topology::Node::getWeight ( ) const

inline

Returns the weight of this node.

Weight is used with the weighted shortest path finder methods of Topology.

Referenced by inet::Topology::calculateWeightedSingleShortestPathsTo().

{ return weight; }

bool inet::Topology::Node::isEnabled ( ) const

inline

Returns true of this node is enabled.

This has significance with the shortest path finder methods of Topology.

Referenced by inet::Topology::calculateWeightedSingleShortestPathsTo().

{ return enabled; }

void inet::Topology::Node::setWeight ( double  d )

inline

Sets the weight of this node.

Weight is used with the weighted shortest path finder methods of Topology.

Referenced by inet::IPv4NetworkConfigurator::addStaticRoutes().

{ weight = d; }

Friends And Related Function Documentation

friend class Topology

friend

Member Data Documentation

double inet::Topology::Node::dist

protected

Referenced by inet::Topology::calculateUnweightedSingleShortestPathsTo(), and inet::Topology::calculateWeightedSingleShortestPathsTo().

bool inet::Topology::Node::enabled

protected

Referenced by inet::Topology::calculateUnweightedSingleShortestPathsTo().

std::vector<Link *> inet::Topology::Node::inLinks

protected

Referenced by inet::Topology::addLink(), inet::Topology::calculateUnweightedSingleShortestPathsTo(), inet::Topology::calculateWeightedSingleShortestPathsTo(), inet::Topology::deleteNode(), inet::Topology::extractFromNetwork(), getLinkIn(), and inet::Topology::unlinkFromDestNode().

int inet::Topology::Node::moduleId

protected

Referenced by inet::Topology::addNode(), inet::Topology::extractFromNetwork(), inet::Topology::isModuleIdLess(), and inet::Topology::lessByModuleId().

std::vector<Link *> inet::Topology::Node::outLinks

protected

Referenced by inet::Topology::addLink(), inet::Topology::deleteNode(), inet::Topology::extractFromNetwork(), getLinkOut(), and inet::Topology::unlinkFromSourceNode().

Link* inet::Topology::Node::outPath

protected

Referenced by inet::Topology::calculateUnweightedSingleShortestPathsTo(), and inet::Topology::calculateWeightedSingleShortestPathsTo().

double inet::Topology::Node::weight

protected

---

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

• Topology.h
• Topology.cc