Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
karto::Edge< T > Class Template Reference

#include <Mapper.h>

Public Member Functions

 Edge ()
 
 Edge (Vertex< T > *pSource, Vertex< T > *pTarget)
 
EdgeLabelGetLabel ()
 
Vertex< T > * GetSource () const
 
Vertex< T > * GetTarget () const
 
void SetLabel (EdgeLabel *pLabel)
 
virtual ~Edge ()
 

Private Member Functions

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

Private Attributes

EdgeLabelm_pLabel
 
Vertex< T > * m_pSource
 
Vertex< T > * m_pTarget
 

Friends

class boost::serialization::access
 

Detailed Description

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

Represents an edge in a graph

Definition at line 247 of file Mapper.h.

Constructor & Destructor Documentation

◆ Edge() [1/2]

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

Constructs an edge from the source to target vertex

Parameters
pSource
pTarget

Definition at line 404 of file Mapper.h.

◆ Edge() [2/2]

template<typename T >
karto::Edge< T >::Edge ( Vertex< T > *  pSource,
Vertex< T > *  pTarget 
)
inline

Definition at line 410 of file Mapper.h.

◆ ~Edge()

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

Destructor

Definition at line 422 of file Mapper.h.

Member Function Documentation

◆ GetLabel()

template<typename T >
EdgeLabel* karto::Edge< T >::GetLabel ( )
inline

Gets the link info

Returns
link info

Definition at line 457 of file Mapper.h.

◆ GetSource()

template<typename T >
Vertex<T>* karto::Edge< T >::GetSource ( ) const
inline

Gets the source vertex

Returns
source vertex

Definition at line 439 of file Mapper.h.

◆ GetTarget()

template<typename T >
Vertex<T>* karto::Edge< T >::GetTarget ( ) const
inline

Gets the target vertex

Returns
target vertex

Definition at line 448 of file Mapper.h.

◆ serialize()

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

Definition at line 478 of file Mapper.h.

◆ SetLabel()

template<typename T >
void karto::Edge< T >::SetLabel ( EdgeLabel pLabel)
inline

Sets the link payload

Parameters
pLabel

Definition at line 466 of file Mapper.h.

Friends And Related Function Documentation

◆ boost::serialization::access

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

Definition at line 476 of file Mapper.h.

Member Data Documentation

◆ m_pLabel

template<typename T >
EdgeLabel* karto::Edge< T >::m_pLabel
private

Definition at line 474 of file Mapper.h.

◆ m_pSource

template<typename T >
Vertex<T>* karto::Edge< T >::m_pSource
private

Definition at line 472 of file Mapper.h.

◆ m_pTarget

template<typename T >
Vertex<T>* karto::Edge< T >::m_pTarget
private

Definition at line 473 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