dsf::Edge Class Reference

Inheritance diagram for dsf::Edge:

Public Member Functions
	Edge (Id id, std::pair< Id, Id > nodePair, geometry::PolyLine geometry={})
	Construct a new Edge object.
	Edge (Edge &&)=default
	Edge (const Edge &)=delete
void	resetId (Id newId)
void	setGeometry (geometry::PolyLine geometry)
void	setWeight (double const weight)
Id	id () const
	Get the edge's id.
Id	source () const
	Get the edge's source node id.
Id	target () const
	Get the edge's target node id.
std::pair< Id, Id > const &	nodePair () const
	Get the edge's node pair.
geometry::PolyLine const &	geometry () const
	Get the edge's geometry.
double	angle () const
	Get the edge's angle, in radians, between the source and target nodes.
double	weight () const
	Get the edge's weight.
virtual bool	isFull () const =0
double	deltaAngle (double const previousEdgeAngle) const

Protected Member Functions
void	m_setAngle (geometry::Point srcNodeCoordinates, geometry::Point dstNodeCoordinates)

Protected Attributes
geometry::PolyLine	m_geometry
Id	m_id
std::pair< Id, Id >	m_nodePair
std::optional< double >	m_weight
double	m_angle

Constructor & Destructor Documentation

Edge()

dsf::Edge::Edge	(	Id	id,
		std::pair< Id, Id >	nodePair,
		geometry::PolyLine	geometry = {} )

Construct a new Edge object.

Parameters

id	The edge's id
nodePair	The edge's node pair (u, v) with the edge u -> v
geometry	The edge's geometry, a vector of pairs of doubles representing the coordinates of the edge's geometry. Default is an empty vector.

Member Function Documentation

angle()

double dsf::Edge::angle

(

)

const

Get the edge's angle, in radians, between the source and target nodes.

Returns

double The edge's angle, in radians

geometry()

geometry::PolyLine const & dsf::Edge::geometry

(

)

const

Get the edge's geometry.

Returns

dsf::geometry::PolyLine The edge's geometry, a vector of pairs of doubles representing the coordinates of the edge's geometry

id()

Id dsf::Edge::id

(

)

const

Get the edge's id.

Returns

Id The edge's id

isFull()

virtual bool dsf::Edge::isFull ( ) const

pure virtual

Implemented in dsf::mobility::Street.

nodePair()

std::pair< Id, Id > const & dsf::Edge::nodePair

(

)

const

Get the edge's node pair.

Returns

std::pair<Id, Id> The edge's node pair, where the first element is the source node id and the second element is the target node id. The pair is (u, v) with the edge u -> v.

source()

Id dsf::Edge::source

(

)

const

Get the edge's source node id.

Returns

Id The edge's source node id

target()

Id dsf::Edge::target

(

)

const

Get the edge's target node id.

Returns

Id The edge's target node id

weight()

double dsf::Edge::weight

(

)

const

Get the edge's weight.

Returns

double The edge's weight

---

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

• src/dsf/base/Edge.hpp
• src/dsf/base/Edge.cpp