Vertex< V > Class Template Reference
A vertex of a graph. It stores user information, an optional name, and keeps an internal unique Id. This class does not enforce to choose a unique name. More...
#include <Vertex.hh>
Public Member Functions | |
Vertex (const std::string &_name, const V &_data=V(), const VertexId _id=kNullId) | |
Constructor. | |
V & | Data () |
Get a mutable reference to the user information. | |
const V & | Data () const |
Retrieve the user information. | |
VertexId | Id () const |
Get the vertex Id. | |
const std::string & | Name () const |
Get the vertex name. | |
void | SetName (const std::string &_name) |
Set the vertex name. | |
bool | Valid () const |
Whether the vertex is considered valid or not (id==kNullId). | |
Static Public Attributes | |
static Vertex< V > | NullVertex |
An invalid vertex. | |
Detailed Description
A vertex of a graph. It stores user information, an optional name, and keeps an internal unique Id. This class does not enforce to choose a unique name.
Constructor & Destructor Documentation
◆ Vertex()
Constructor.
- Parameters
-
[in] _name Non-unique vertex name. [in] _data User information. [in] _id Optional unique id.
Member Function Documentation
◆ Data() [1/2]
Get a mutable reference to the user information.
- Returns
- Mutable reference to the user information.
◆ Data() [2/2]
Retrieve the user information.
- Returns
- Reference to the user information.
◆ Id()
◆ Name()
|
inline |
Get the vertex name.
- Returns
- The vertex name.
◆ SetName()
|
inline |
Set the vertex name.
- Parameters
-
[in] _name The vertex name.
◆ Valid()
Whether the vertex is considered valid or not (id==kNullId).
- Returns
- True when the vertex is valid or false otherwise (id==kNullId)
References gz::math::graph::kNullId.
Member Data Documentation
◆ NullVertex
The documentation for this class was generated from the following file: