karto::Vertex< T > Class Template Reference

#include <Mapper.h>

Public Member Functions
std::vector< Vertex< T > * >	GetAdjacentVertices () const
const std::vector< Edge< T > * > &	GetEdges () const
T *	GetObject () const
const double	GetScore () const
void	RemoveEdge (const int &idx)
void	RemoveObject ()
void	SetScore (const double score)
	Vertex ()
	Vertex (T *pObject)
virtual	~Vertex ()

Private Member Functions
void	AddEdge (Edge< T > *pEdge)
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
std::vector< Edge< T > * >	m_Edges
T *	m_pObject
kt_double	m_Score

Friends
class	boost::serialization::access
class	Edge< T >

Detailed Description

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

Represents an object in a graph

Definition at line 253 of file Mapper.h.

Constructor & Destructor Documentation

Vertex() [1/2]

template<typename T >

karto::Vertex< T >::Vertex ( )

inline

Constructs a vertex representing the given object

Parameters

pObject

Definition at line 262 of file Mapper.h.

Vertex() [2/2]

template<typename T >

karto::Vertex< T >::Vertex ( T *  pObject )

inline

Definition at line 266 of file Mapper.h.

~Vertex()

template<typename T >

virtual karto::Vertex< T >::~Vertex ( )

inlinevirtual

Destructor

Definition at line 274 of file Mapper.h.

Member Function Documentation

AddEdge()

template<typename T >

void karto::Vertex< T >::AddEdge ( Edge< T > *  pEdge )

inlineprivate

Adds the given edge to this vertex's edge list

Parameters

pEdge

edge to add

Definition at line 369 of file Mapper.h.

GetAdjacentVertices()

template<typename T >

std::vector<Vertex<T>*> karto::Vertex< T >::GetAdjacentVertices ( ) const

inline

Gets a vector of the vertices adjacent to this vertex

Returns

adjacent vertices

Definition at line 336 of file Mapper.h.

GetEdges()

template<typename T >

const std::vector<Edge<T>*>& karto::Vertex< T >::GetEdges ( ) const

inline

Gets edges adjacent to this vertex

Returns

adjacent edges

Definition at line 282 of file Mapper.h.

GetObject()

template<typename T >

T* karto::Vertex< T >::GetObject ( ) const

inline

Gets the object associated with this vertex

Returns

the object

Definition at line 319 of file Mapper.h.

GetScore()

template<typename T >

const double karto::Vertex< T >::GetScore ( ) const

inline

Gets score for vertex

Returns

score

Definition at line 301 of file Mapper.h.

RemoveEdge()

template<typename T >

void karto::Vertex< T >::RemoveEdge ( const int &  idx )

inline

Removes an edge at a position

Definition at line 290 of file Mapper.h.

RemoveObject()

template<typename T >

void karto::Vertex< T >::RemoveObject ( )

inline

Deletes the object held by this vertex

Definition at line 327 of file Mapper.h.

serialize()

template<typename T >

template<class Archive >

void karto::Vertex< T >::serialize ( Archive &  ar, const unsigned int  version  )

inlineprivate

Definition at line 380 of file Mapper.h.

SetScore()

template<typename T >

void karto::Vertex< T >::SetScore ( const double  score )

inline

Sets score for vertex

Returns

adjacent edges

Definition at line 310 of file Mapper.h.

Friends And Related Function Documentation

boost::serialization::access

template<typename T >

friend class boost::serialization::access

friend

Definition at line 378 of file Mapper.h.

Edge< T >

template<typename T >

friend class Edge< T >

friend

Definition at line 255 of file Mapper.h.

Member Data Documentation

m_Edges

template<typename T >

std::vector<Edge<T>*> karto::Vertex< T >::m_Edges

private

Definition at line 375 of file Mapper.h.

m_pObject

template<typename T >

T* karto::Vertex< T >::m_pObject

private

Definition at line 374 of file Mapper.h.

m_Score

template<typename T >

kt_double karto::Vertex< T >::m_Score

private

Definition at line 376 of file Mapper.h.

---

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

• Mapper.h