implementation.simulator.src.xmlsolution Namespace Reference

Functions
def	maxValueAndIndex
	Get the maximum value of an index. More...
def	floats2str
	Convert a list of floats to a string where the floats are separated by a comma. More...
def	translate
	Translate an internal symbol to a user comprehensive text. More...
def	export
	Export the solution to a XML file. More...

Variables
dictionary	TRANSLATE_DICT
	Translate dictionary. More...

Function Documentation

def implementation.simulator.src.xmlsolution.export	(		xmlPath,
			data,
			externs = []
	)

Export the solution to a XML file.

Parameters

xmlPath	Path to the XML file.
data	Data.
externs	List of externs to the image which needs to output data. The externs should implement a method "xmlData" which takes the data structure as argument and returns a string with the data.

def implementation.simulator.src.xmlsolution.floats2str

(

floatList

)

Convert a list of floats to a string where the floats are separated by a comma.

Parameters

floatList

List of floats.

def implementation.simulator.src.xmlsolution.maxValueAndIndex

(

vect

)

Get the maximum value of an index.

Parameters

vect	Vector of elements.

Returns

value,index+1.

def implementation.simulator.src.xmlsolution.translate

(

symbol

)

Translate an internal symbol to a user comprehensive text.

Parameters

symbol

Symbol to translate.

Returns

The translation. If no correspondance is found, returns the symbol itself.

Variable Documentation

dictionary TRANSLATE_DICT

Initial value:

= {'I':'Imbalance','O':'Opposite usage of flexibility','TU':'Total usage of flexibility',
                                'R+':'Requirement of upward flexibility','R-':'Requirement of downward flexibility',
                                'S+':'Submitted upward flexibility','S-':'Submitted downward flexibility',
                                'A+':'Upward flexibility contracted','A-':'Downward flexibility contracted',
                                'U+':'Activated upward flexibility','U-':'Activated downward flexibility',
                                'pi^E':'Energy price','pi^I+':'Upward imbalance price','pi^I-':'Downward imbalance price',
                                'C':'Line capacity','dC':'Max. capacity upgrade',
                                'g':'Downward access request bound','G':'Upward access request bound',
                                'b':'Safe downward access bound','B':'Safe upward access bound',
                                'k':'Downward flexible access bound','K':'Upward flexible access bound',
                                'l':'Downward full access bound','L':'Upward full access bound',
                                'p^b':'Local baseline','p^r':'Local corrected baseline','p':'Local realization','p^p':'Baseline proposal',
                                'P^b':'Global baseline','P^r':'Global corrected baseline','P':'Global realization',
                                'H':'Flexibility request','U':'Flexibility activation',
                                'h':'Local flexibility request','u':'Local flexibility activation',
                                'f^b':'Announced flow','f^r':'Corrected flow','f':'Flow realization',
                                'dpL^max':'Maximum upward dynamic flexibility', 'dpU^max':'Maximum downward dynamic flexibility',
                                'dpL':'Upward dynamic flexibility', 'dpU':'Downward dynamic flexibility',
                                'd':'Downward periodic access bound', 'D':'Upward periodic access bound'
}

Translate dictionary.