DataKeeper (class)

Method code available at https://github.com/Eomys/pyleecan/tree/master/pyleecan/Methods/Simulation/DataKeeper

class DataKeeper(name='', symbol='', unit='', keeper=None, error_keeper=None, result=-1, result_ref=None, init_dict=None, init_str=None)[source]

Bases: pyleecan.Classes._frozen.FrozenClass

Class for defining data to keep on a multi-simulation

VERSION = 1
as_dict(**kwargs)

Convert this object in a json serializable dict (can be use in __init__). Optional keyword input parameter is for internal use only and may prevent json serializability.

save(save_path='', is_folder=False)

Save the object to the save_path

Parameters
  • self – A pyleecan object

  • save_path (str) – path to the folder to save the object

  • is_folder (bool) – to split the object in different files: separate simulation machine and materials

copy(**kwargs)

Return a copy of the class

get_logger()

Get the object logger or its parent’s one

Parameters

obj – A pyleecan object

Returns

logger – Pyleecan object dedicated logger

Return type

logging.Logger

compare(other, name='self')[source]

Compare two objects and return list of differences

property name

Data name

Type

str

property symbol

Data symbol

Type

str

property unit

Data unit

Type

str

property keeper

Function that takes an Output in argument and return a value

Type

function

property error_keeper

Function that takes a Simulation in argument and returns a value, this attribute enables to handle errors and to put NaN values in the result matrices

Type

function

property result

List containing datakeeper results for each simulation

Type

list

property result_ref

Result for the reference simulation

Type