Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
karto::Graph< T > Class Template Reference

#include <Mapper.h>

Public Types

typedef std::map< Name, std::map< int, Vertex< T > * > > VertexMap
 

Public Member Functions

void AddEdge (Edge< T > *pEdge)
 
void AddVertex (const Name &rName, Vertex< T > *pVertex)
 
void Clear ()
 
const std::vector< Edge< T > * > & GetEdges () const
 
const VertexMapGetVertices () const
 
 Graph ()
 
void RemoveEdge (const int &idx)
 
void RemoveVertex (const Name &rName, const int &idx)
 
virtual ~Graph ()
 

Protected Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Protected Attributes

std::vector< Edge< T > * > m_Edges
 
VertexMap m_Vertices
 

Friends

class boost::serialization::access
 

Detailed Description

template<typename T>
class karto::Graph< T >

Graph

Definition at line 515 of file Mapper.h.

Member Typedef Documentation

◆ VertexMap

template<typename T >
typedef std::map<Name, std::map<int, Vertex<T>*> > karto::Graph< T >::VertexMap

Maps names to vector of vertices

Definition at line 567 of file Mapper.h.

Constructor & Destructor Documentation

◆ Graph()

template<typename T >
karto::Graph< T >::Graph ( )
inline

Default constructor

Definition at line 573 of file Mapper.h.

◆ ~Graph()

template<typename T >
virtual karto::Graph< T >::~Graph ( )
inlinevirtual

Destructor

Definition at line 580 of file Mapper.h.

Member Function Documentation

◆ AddEdge()

template<typename T >
void karto::Graph< T >::AddEdge ( Edge< T > *  pEdge)
inline

Adds an edge to the graph

Parameters
pEdge

Definition at line 620 of file Mapper.h.

◆ AddVertex()

template<typename T >
void karto::Graph< T >::AddVertex ( const Name rName,
Vertex< T > *  pVertex 
)
inline

Adds and indexes the given vertex into the map using the given name

Parameters
rName
pVertex

Definition at line 591 of file Mapper.h.

◆ Clear()

template<typename T >
void karto::Graph< T >::Clear ( )
inline

Deletes the graph data

Definition at line 639 of file Mapper.h.

◆ GetEdges()

template<typename T >
const std::vector<Edge<T>*>& karto::Graph< T >::GetEdges ( ) const
inline

Gets the edges of this graph

Returns
graph edges

Definition at line 665 of file Mapper.h.

◆ GetVertices()

template<typename T >
const VertexMap& karto::Graph< T >::GetVertices ( ) const
inline

Gets the vertices of this graph

Returns
graph vertices

Definition at line 674 of file Mapper.h.

◆ RemoveEdge()

template<typename T >
void karto::Graph< T >::RemoveEdge ( const int &  idx)
inline

Removes an edge to the graph

Parameters
pEdge

Definition at line 629 of file Mapper.h.

◆ RemoveVertex()

template<typename T >
void karto::Graph< T >::RemoveVertex ( const Name rName,
const int &  idx 
)
inline

Removes a given vertex into the map using the given name

Parameters
rName
pVertex

Definition at line 601 of file Mapper.h.

◆ serialize()

template<typename T >
template<class Archive >
void karto::Graph< T >::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprotected

Definition at line 694 of file Mapper.h.

Friends And Related Function Documentation

◆ boost::serialization::access

template<typename T >
friend class boost::serialization::access
friend

Serialization: class Graph

Definition at line 692 of file Mapper.h.

Member Data Documentation

◆ m_Edges

template<typename T >
std::vector<Edge<T>*> karto::Graph< T >::m_Edges
protected

Edges of this graph

Definition at line 688 of file Mapper.h.

◆ m_Vertices

template<typename T >
VertexMap karto::Graph< T >::m_Vertices
protected

Map of names to vector of vertices

Definition at line 683 of file Mapper.h.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Thu Jan 11 2024 03:37:56