Gazebo Math

API Reference

8.1.0
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.
 
VData ()
 Get a mutable reference to the user information.
 
const VData () const
 Retrieve the user information.
 
VertexId Id () const
 Get the vertex Id.
 
const std::stringName () 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< VNullVertex
 An invalid vertex.
 

Detailed Description

template<typename V>
class gz::math::graph::Vertex< V >

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()

template<typename V >
Vertex ( const std::string _name,
const V _data = V(),
const VertexId  _id = kNullId 
)
inline

Constructor.

Parameters
[in]_nameNon-unique vertex name.
[in]_dataUser information.
[in]_idOptional unique id.

Member Function Documentation

◆ Data() [1/2]

template<typename V >
V & Data ( )
inline

Get a mutable reference to the user information.

Returns
Mutable reference to the user information.

◆ Data() [2/2]

template<typename V >
const V & Data ( ) const
inline

Retrieve the user information.

Returns
Reference to the user information.

◆ Id()

template<typename V >
VertexId Id ( ) const
inline

Get the vertex Id.

Returns
The vertex Id.

◆ Name()

template<typename V >
const std::string & Name ( ) const
inline

Get the vertex name.

Returns
The vertex name.

◆ SetName()

template<typename V >
void SetName ( const std::string _name)
inline

Set the vertex name.

Parameters
[in]_nameThe vertex name.

◆ Valid()

template<typename V >
bool Valid ( ) const
inline

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

template<typename V >
Vertex< V > NullVertex
static

An invalid vertex.


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