python.SurrogateModel.IndexSet Class Reference

Inheritance diagram for python.SurrogateModel.IndexSet:

Public Member Functions
def	__init__ (self, args, kwargs)
def	get_name (self, index)
	Method obtaining name of a specie in the index set. More...
def	get_index (self, name)
	Method obtaining index for a specie in the index set. More...
def	iterator_end (self)
	Method returning length of the "names" list. More...
def	iterator_size (self)
	Method returning length of the "names" list. More...
def	exceptionLoad (self, indexSetId)
	Method raising a exception when a surrogate model has not been instantiated.
def	load (self, indexSetId)
	Method loading a index set object from the database. More...

Static Public Attributes
	name = StringField(primary_key=True)
	names = ListField(StringField(required=True))
dictionary	meta = {'allow_inheritance': True}

Detailed Description

Definition at line 159 of file SurrogateModel.py.

Member Function Documentation

get_index()

def python.SurrogateModel.IndexSet.get_index	(		self,
			name
	)

Method obtaining index for a specie in the index set.

Parameters

name	(str) name of a specie in the index set.

Returns

(int) index for specie "name" in "names" list

Definition at line 196 of file SurrogateModel.py.

get_name()

def python.SurrogateModel.IndexSet.get_name	(		self,
			index
	)

Method obtaining name of a specie in the index set.

Parameters

index

(int) index for of a specie in the index set.

Returns

(str) name of the specie "index".

Definition at line 183 of file SurrogateModel.py.

iterator_end()

def python.SurrogateModel.IndexSet.iterator_end

(

self

)

Method returning length of the "names" list.

Definition at line 205 of file SurrogateModel.py.

iterator_size()

def python.SurrogateModel.IndexSet.iterator_size

(

self

)

Method returning length of the "names" list.

Definition at line 211 of file SurrogateModel.py.

load()

def python.SurrogateModel.IndexSet.load	(		self,
			indexSetId
	)

Method loading a index set object from the database.

Parameters

indexSetId

(str) id of the index set that is to be loaded.

Definition at line 229 of file SurrogateModel.py.

---

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

• src/python/SurrogateModel.py