zeus::TVertice Class Reference

#include <Vertice.h>

List of all members.

Public Member Functions
	TVertice (Uint uiID, const IZUnknown *pObject)
virtual Retval	clone (TVertice *&rpVertice) const
virtual bool	equals (const TVertice &rVertice, bool bIgnoreID=false) const
virtual Int	getEdgeCount () const
virtual void	getEdgeList (IList< TEdge > &rList) const
virtual void	getEdgeList (Uint uiNeighbourVertice, IList< TEdge > &rList) const
virtual void	getNextVertices (IList< Uint > &rList) const
virtual void	getNextVertices (IList< Uint > &rList, IList< Float > &rWeights) const
virtual Retval	getObject (IZUnknown *&rpObject) const
Float	getWeightSum (Uint uiToID) const
bool	hasEdge (Uint uiNextVertice) const
Uint	getID () const
Protected Member Functions
virtual	~TVertice ()
virtual Retval	addEdge (TEdge &rEdge)
virtual void	clearEdges ()
virtual void	removeEdge (TEdge &rEdge)
Friends
class	TGraph

---

Detailed Description

Implementation of the graph edge

---

Constructor & Destructor Documentation

TVertice::TVertice	(	Uint	uiID,
		const IZUnknown *	pObject
	)

Creates a vertice

Parameters:

uiID	: ID of the vertice
pObject	: Associated object

TVertice::~TVertice

(

)

[protected, virtual]

Destroys the vertice

---

Member Function Documentation

Retval TVertice::addEdge

(

TEdge &

rEdge )

[protected, virtual]

Adds an edge to the internal vertice list

void zeus::TVertice::clearEdges

(

)

[inline, protected, virtual]

removes all edges of the internal list

Retval TVertice::clone

(

TVertice *&

rpVertice )

const [virtual]

this clones the vertice, but not its edges to other vertices

bool TVertice::equals	(	const TVertice &	rVertice,
		bool	bIgnoreID = false
	)		const [virtual]

Checks if two vertices are equal

Parameters:

rVertice	: Vertice to check
bIgnoreID	: If this flag is set the vertice ID will be ignored. This is usefull for isomorphism checks

Return values:

true	: Vertices are equal
false,:	Vertices are not equal

Int zeus::TVertice::getEdgeCount

(

)

const [inline, virtual]

Returns the number of edges of this vertice.

Returns:

number of edges

void zeus::TVertice::getEdgeList

(

IList< TEdge > &

rList )

const [inline, virtual]

Returns the list of all edges of this vertice.

void TVertice::getEdgeList	(	Uint	uiNeighbourVertice,
		IList< TEdge > &	rList
	)		const [virtual]

returns all edges of between this vertice and vertice uiNeighbourVertice

Parameters:

uiNeighbourVertice	: ID of neighbour vertice
rList	: list of edges as return parameter

Uint zeus::TVertice::getID

(

)

const [inline]

Returns the ID of the vertice

void TVertice::getNextVertices	(	IList< Uint > &	rList,
		IList< Float > &	rWeights
	)		const [virtual]

Returns the next vertices from this vertice (neighbours)

Parameters:

rList	: Return parameter of neighbours
rWeights	: Return parameter of weights

void TVertice::getNextVertices

(

IList< Uint > &

rList )

const [virtual]

Returns the next vertices from this vertice (neighbours)

Parameters:

rList

: Return parameter

Retval TVertice::getObject

(

IZUnknown *&

rpObject )

const [virtual]

Returns the object of the vertice

Float TVertice::getWeightSum

(

Uint

uiToID )

const

Returns the weight sum of all edges from this vertice to a specific vertice

Parameters:

uiToID

: target vertice

Returns:

Weight of all edges

bool TVertice::hasEdge

(

Uint

uiNextVertice )

const

Checks if the vertice has an edge to a next vertice

Parameters:

uiNextVertice

: ID of the next vertice

Return values:

true	: edge found
false	: no edge found

void zeus::TVertice::removeEdge

(

TEdge &

rEdge )

[inline, protected, virtual]

removes the edge of the internal list

---

Friends And Related Function Documentation

friend class TGraph [friend]

---

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

• Vertice.h
• Vertice.cpp