inet::Topology::LinkOut Class Reference

Supporting class for Topology. More...

#include <Topology.h>

Inheritance diagram for inet::Topology::LinkOut:

Public Member Functions
Node *	getRemoteNode () const
	Returns the node at the remote end of this connection. More...
Node *	getLocalNode () const
	Returns the node at the local end of this connection. More...
int	getRemoteGateId () const
	Returns the gate ID at the remote end of this connection. More...
int	getLocalGateId () const
	Returns the gate ID at the local end of this connection. More...
cGate *	getRemoteGate () const
	Returns the gate at the remote end of this connection. More...
cGate *	getLocalGate () const
	Returns the gate at the local end of this connection. More...
Public Member Functions inherited from inet::Topology::Link
	Link (double weight=1)
	Constructor. More...
virtual	~Link ()
double	getWeight () const
	Returns the weight of this link. More...
void	setWeight (double d)
	Sets the weight of this link. More...
bool	isEnabled () const
	Returns true of this link is enabled. More...
void	enable ()
	Enables this link. More...
void	disable ()
	Disables this link. More...

Additional Inherited Members
Protected Attributes inherited from inet::Topology::Link
Node *	srcNode
int	srcGateId
Node *	destNode
int	destGateId
double	weight
bool	enabled

Detailed Description

Supporting class for Topology.

While navigating the graph stored in a Topology, Node's methods return LinkIn and LinkOut objects, which are 'aliases' to Link objects. LinkIn and LinkOut provide convenience functions that return the 'local' and 'remote' end of the connection when traversing the topology.

Member Function Documentation

cGate* inet::Topology::LinkOut::getLocalGate ( ) const

inline

Returns the gate at the local end of this connection.

Referenced by inet::NetworkConfiguratorBase::computeWiredLinkWeight().

{ return srcNode->getModule()->gate(srcGateId); }

int inet::Topology::LinkOut::getLocalGateId ( ) const

inline

Returns the gate ID at the local end of this connection.

Referenced by inet::NetworkConfiguratorBase::extractTopology(), inet::L2NetworkConfigurator::findLinkOut(), and inet::NetworkConfiguratorBase::findLinkOut().

{ return srcGateId; }

Node* inet::Topology::LinkOut::getLocalNode ( ) const

inline

Returns the node at the local end of this connection.

Referenced by inet::NetworkConfiguratorBase::dumpTopology(), and inet::NetworkConfiguratorBase::extractTopology().

{ return srcNode; }

cGate* inet::Topology::LinkOut::getRemoteGate ( ) const

inline

Returns the gate at the remote end of this connection.

Referenced by inet::STPTester::dfsVisit().

{ return destNode->getModule()->gate(destGateId); }

int inet::Topology::LinkOut::getRemoteGateId ( ) const

inline

Returns the gate ID at the remote end of this connection.

Referenced by inet::NetworkConfiguratorBase::extractTopology(), and inet::NetworkConfiguratorBase::extractWiredNeighbors().

{ return destGateId; }

Node* inet::Topology::LinkOut::getRemoteNode ( ) const

inline

Returns the node at the remote end of this connection.

Referenced by inet::GenericNetworkConfigurator::addStaticRoutes(), inet::IPv4NetworkConfigurator::addStaticRoutes(), inet::STPTester::dfsVisit(), inet::NetworkConfiguratorBase::dumpTopology(), inet::L2NetworkConfigurator::extractTopology(), inet::NetworkConfiguratorBase::extractTopology(), and inet::NetworkConfiguratorBase::extractWiredNeighbors().

{ return destNode; }

---

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

• Topology.h