shamo.core.problems.single.components.sensors.CompSensors

class shamo.core.problems.single.components.sensors.CompSensors(**kwargs)

Bases: shamo.core.problems.single.components.abc.CompABC

Store information about a list of sensors.

Other Parameters

sensorslist [str]

A list of sensor names.

Methods

add	Add a sensor to the list.
adds	Add multiple sensors to the list.
check	Check if the list of sensors is properly set.
clear
copy
fromkeys	Create a new dictionary with keys from iterable and values set to value.
get	Return the value for key if key is in the dictionary, else default.
items
keys
pop	If key is not found, d is returned if given, otherwise KeyError is raised
popitem	Remove and return a (key, value) pair as a 2-tuple.
setdefault	Insert key with a value of default if key is not in the dictionary.
to_pro_param	Return the sensors required to produce the PRO file.
to_py_param	Return the list of sensor names.
update	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values

add(sensor)

Add a sensor to the list.

Parameters

sensorstr

The name of the sensor.

adds(sensors)

Add multiple sensors to the list.

Parameters

sensorslist [str]

The sensor names.

check(name, **kwargs)

Check if the list of sensors is properly set.

Parameters

namestr

The name of the list of sensors.

Other Parameters

sensorsdict [str, shamo.Sensor]

The sensors of the model.

Raises

RuntimeError

If an element in the list is not in the model.

clear() → None. Remove all items from D.

copy() → a shallow copy of D

fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D’s items

keys() → a set-like object providing a view on D’s keys

pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised

popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

to_pro_param(**kwargs)

Return the sensors required to produce the PRO file.

Returns

dict [str, list [dict [str, int]]]

The sensors names and physical points.

Other Parameters

sensorsdict [str, shamo.Sensor]

The sensors of the model.

to_py_param(**kwargs)

Return the list of sensor names.

Returns

list [str]

The list of sensor names.

update([E, ]**F) → None. Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D’s values