numerous.sdk.connect.inputs module#
- class numerous.sdk.connect.inputs.DataListWrapper(data_lists, repeat_offset, previous=None)#
Bases:
objectA helper class that wraps and chains data lists.
- is_after(key)#
- Return type:
bool
- is_before(key)#
- Return type:
bool
- last_index()#
- Return type:
Optional[float]
- last_value(tag)#
- Return type:
float
- read_tag(tag, key)#
- Return type:
float
- remove_previous()#
- Return type:
None
- class numerous.sdk.connect.inputs.HibernatingSourceAction(value)#
Bases:
EnumAn enumeration.
- HIBERNATE_SELF = 0#
- WAIT = 1#
- class numerous.sdk.connect.inputs.InputReader(spm_stub, hibernation_handler, identity, execution_id, job, input_sources, input_variables, hibernating_source_action, step=1.0, repeat_spacing=None, update_progress=False)#
Bases:
Iterable[tuple[datetime,dict[str,float]]]Reads input data according to the time setup of the current job.
The input reader is meant to be used to iterate over the input data of the current job, taking into account the alignment of input sources, and input variables.
During iteration the value attribute of
InputVariableobjects in the scenario will be updated.
- exception numerous.sdk.connect.inputs.InputSourceHibernating(stream, key)#
Bases:
ExceptionRaised when reaching the end of a hibernating input source.
- class numerous.sdk.connect.inputs.InputStream(spm_stub, job_start_time, job_end_time, input_source, input_variables, repeat_spacing=None)#
Bases:
objectA helper class that reads data from a specific input source.
- check_and_handle_resume_after_hibernation(key)#
- Return type:
bool
- read_variables(key)#
- Return type:
dict[str,float]
- exception numerous.sdk.connect.inputs.ReadRetryExhausted#
Bases:
ExceptionRaised when reading has been retried too many times.