pogona.Component

class pogona.Component[source]

Bases: ABC

Base class for simulation components that can be configured via YAML files.

Attributes

`component_name`	Unique name of this component, unless it is "Generic component".
`id`	Unique integer component ID

Methods

`__init__`()
`finalize`(simulation_kernel)
`initialize`(simulation_kernel, init_stage)	Use `InitStages` to initialize this Component instance.
`process_new_time_step`(simulation_kernel, ...)
`set_arguments`(**kwargs)	Read arguments as key value pairs and set this component's member variables accordingly.

initialize(simulation_kernel: SimulationKernel, init_stage: InitStages)[source]: Use InitStages to initialize this Component instance.

process_new_time_step(simulation_kernel: SimulationKernel, notification_stage: NotificationStages)[source]

set_arguments(**kwargs)[source]: Read arguments as key value pairs and set this component’s member variables accordingly. Validity of the argument values will be checked in initialize().

component_name = 'Generic component': Unique name of this component, unless it is “Generic component”.