Référence de la classe PCCEdge

Connexion orientée entre deux PCCNode du PCCGraph. Plus de détails...

#include <PCCEdge.h>

Graphe de collaboration de PCCEdge:

Fonctions membres publiques
	PCCEdge (PCCNode *from, PCCNode *to, PCCEdgeRole role, Logger &logger)
	Construit une arête orientée entre deux nœuds.
	PCCEdge (const PCCEdge &)=delete
	Interdit la copie — aliasing des pointeurs non-propriétaires.
PCCEdge &	operator= (const PCCEdge &)=delete
	PCCEdge (PCCEdge &&)=default
	Déplacement autorisé — requis par unique_ptr.
PCCEdge &	operator= (PCCEdge &&)=default
	~PCCEdge ()=default
PCCNode *	getFrom () const
	Retourne le nœud source de l'arête.
PCCNode *	getTo () const
	Retourne le nœud cible de l'arête.
PCCEdgeRole	getRole () const
	Retourne le rôle sémantique de la connexion.

Attributs privés
PCCNode *	m_from = nullptr
PCCNode *	m_to = nullptr
PCCEdgeRole	m_role
Logger &	m_logger

Description détaillée

Connexion orientée entre deux PCCNode du PCCGraph.

Règles de copie / déplacement :

• Copie interdite — aliasing des pointeurs non-propriétaires.
• Déplacement autorisé — requis par le stockage dans unique_ptr.

Documentation des constructeurs et destructeur

PCCEdge() [1/3]

PCCEdge::PCCEdge	(	PCCNode *	from,
		PCCNode *	to,
		PCCEdgeRole	role,
		Logger &	logger
	)

Construit une arête orientée entre deux nœuds.

Paramètres

from	Nœud source. Ne doit pas être nullptr.
to	Nœud cible. Ne doit pas être nullptr.
role	Rôle sémantique de la connexion.
logger	Référence au logger HMI fourni par PCCGraph.

Exceptions

std::invalid_argument

Si from ou to est nullptr.

PCCEdge() [2/3]

PCCEdge::PCCEdge ( const PCCEdge &  )

delete

Interdit la copie — aliasing des pointeurs non-propriétaires.

PCCEdge() [3/3]

PCCEdge::PCCEdge ( PCCEdge &&  )

default

Déplacement autorisé — requis par unique_ptr.

~PCCEdge()

PCCEdge::~PCCEdge ( )

default

Documentation des fonctions membres

getFrom()

PCCNode * PCCEdge::getFrom ( ) const

inline

Retourne le nœud source de l'arête.

Renvoie

Pointeur non-propriétaire vers le nœud source. Jamais nullptr.

getRole()

PCCEdgeRole PCCEdge::getRole ( ) const

inline

Retourne le rôle sémantique de la connexion.

Renvoie

PCCEdgeRole identifiant la nature de la branche.

getTo()

PCCNode * PCCEdge::getTo ( ) const

inline

Retourne le nœud cible de l'arête.

Renvoie

Pointeur non-propriétaire vers le nœud cible. Jamais nullptr.

operator=() [1/2]

PCCEdge & PCCEdge::operator= ( const PCCEdge &  )

delete

operator=() [2/2]

PCCEdge & PCCEdge::operator= ( PCCEdge &&  )

default

Documentation des données membres

m_from

PCCNode* PCCEdge::m_from = nullptr

private

Nœud source — non-propriétaire, durée de vie garantie par PCCGraph.

m_logger

Logger& PCCEdge::m_logger

private

Logger de la class

m_role

PCCEdgeRole PCCEdge::m_role

private

Rôle sémantique de la connexion dans la topologie ferroviaire.

m_to

PCCNode* PCCEdge::m_to = nullptr

private

Nœud cible — non-propriétaire, durée de vie garantie par PCCGraph.

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• SimulateurFerroviaire/Modules/PCC/PCCEdge.h
• SimulateurFerroviaire/Modules/PCC/PCCEdge.cpp