Retailer Class Reference

Retailer agent. More...

Inheritance diagram for Retailer:

Collaboration diagram for Retailer:

Public Member Functions
def	__init__
	Constructor. More...
def	initialize
def	act
def	referenceFlexPrice
def	flexibilityEvaluation
	Evaluate and request the flexibility offers. More...
def	xmlData
	Get the data to display. More...

Public Attributes
	nodes
	List of nodes with flexible loads. More...
	piR
	Base reservation cost per period. More...
	piF
	Retailing price per period. More...

Static Public Attributes
string	baselinesDataFile = 'retailer-baselines.dat'
	Name of the data file with the baselines. More...
string	submittedNodalTotalConsumptionsDataFile = 'retailer-submittedNodalTotalConsumptions.dat'
	Name of the data file with the submitted nodal total consumptions. More...

Private Member Functions
def	_settlement
	Settlement. More...
def	_optimizeImbalance
	Optimize the final imbalance of the retailer. More...
def	_flexibilityActivation
	Activation of the contracted flexibility. More...
def	_optimizeFlexibility
	Optimize the flexibility of the retailer. More...
def	_optimizeBaseline
	Optimize the consumption strategy of the retailer. More...
def	_writeNodalTotalConsumption
	Write the nodal total consumption based on the submitted baselines. More...
def	_readData
	Read the data file of the retailer. More...

Private Attributes
	_dataFile
	CSV file with the fixed data of the problem. More...

Detailed Description

Retailer agent.

Constructor & Destructor Documentation

def __init__	(		self,
			dataFile,
			name = ""
	)

Constructor.

Parameters

dataFile

Data of the retailer.

See also

_dataFile

Parameters

name	Retailer's name.

See also

rename()

Member Function Documentation

def _flexibilityActivation (   self,   data  )

private

Activation of the contracted flexibility.

Parameters

data

Data.

def _optimizeBaseline (   self,   data,   layer = None  )

private

Optimize the consumption strategy of the retailer.

Parameters

data	Data.
layer	Layer

def _optimizeFlexibility (   self,   data  )

private

Optimize the flexibility of the retailer.

Parameters

data

Data.

def _optimizeImbalance (   self,   data  )

private

Optimize the final imbalance of the retailer.

Parameters

data

Data.

def _readData (   self,   data  )

private

Read the data file of the retailer.

Parameters

data

Data.

def _settlement (   self,   data  )

private

Settlement.

Parameters

data

Data.

def _writeNodalTotalConsumption (   self,   data  )

private

Write the nodal total consumption based on the submitted baselines.

def act	(		self,
			data,
			layer
	)

def flexibilityEvaluation	(		self,
			data
	)

Evaluate and request the flexibility offers.

Parameters

data

Data.

def initialize	(		self,
			data
	)

def referenceFlexPrice	(		self,
			n,
			t
	)

def xmlData	(		self,
			data
	)

Get the data to display.

Parameters

data

Data.

Returns

XML data string.

Member Data Documentation

_dataFile

private

CSV file with the fixed data of the problem.

string baselinesDataFile = 'retailer-baselines.dat'

static

Name of the data file with the baselines.

nodes

List of nodes with flexible loads.

piF

Retailing price per period.

piR

Base reservation cost per period.

string submittedNodalTotalConsumptionsDataFile = 'retailer-submittedNodalTotalConsumptions.dat'

static

Name of the data file with the submitted nodal total consumptions.

---

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

• simulator/src/retailer.py