pygel::BaseElements::WeightedVertices::WeightedVertices Class Reference
[Basic Elements]

List of all members.

---

Detailed Description

Represents a collection of weighted vertices of type BaseElements::WeightedVertices.

Public Member Functions
def	__init__
	Initialize an empty collection.
def	addVertex
	Add vertex to the collection.
def	delVertex
	Delete vertex from the collection.
def	getVertices
	Get all vertices from the collection.
def	findVertex
	Find vertex in the collection.
def	findWeight
	Find weight of a given vertex.
def	hasVertex
	Checks if vertex is present.
Public Attributes
	weightedVertices
	A dictonary of weighted vertices indexed by vertex numbers and values of type BaseElements::WeightedVertex.

---

Member Function Documentation

def pygel::BaseElements::WeightedVertices::WeightedVertices::__init__

(

self

)

Initialize an empty collection.

def pygel::BaseElements::WeightedVertices::WeightedVertices::addVertex	(		self,
			weightedVertex
	)

Add vertex to the collection.

Parameters:

weightedVertex

Weighted vertex to be added. Should be of type BaseElements::WeightedVertex

def pygel::BaseElements::WeightedVertices::WeightedVertices::delVertex	(		self,
			vertexNumber
	)

Delete vertex from the collection.

Parameters:

vertexNumber

Vertex number of the vertex to be deleted

def pygel::BaseElements::WeightedVertices::WeightedVertices::getVertices

(

self

)

Get all vertices from the collection.

Returns:

weightedVertices A dict of all weighted vertices indexed by vertex number

def pygel::BaseElements::WeightedVertices::WeightedVertices::findVertex	(		self,
			vertexNumber
	)

Find vertex in the collection.

Parameters:

vertexNumber

Vertex number to be found

Exceptions:

PackageExceptions::VertexError

Returns:

weightedVertex Found weighted vertex of type BaseElements::WeightedVertex

def pygel::BaseElements::WeightedVertices::WeightedVertices::findWeight	(		self,
			vertexNumber
	)

Find weight of a given vertex.

Parameters:

vertexNumber

Vertex number of the vertex whose weight is to be found

Returns:

vertexWeight Weight of vertex

def pygel::BaseElements::WeightedVertices::WeightedVertices::hasVertex	(		self,
			vertexNumber
	)

Checks if vertex is present.

Parameters:

vertexNumber

Vertex number to be checked

Returns:

0 if vertex is found. Otherwise 1