Module aivis_engine_v2_base_sdk_python.timeseries_data

Classes

class EngineTimeseriesData

Interface for handling engine timeseries data.

Ancestors

• abc.ABC

Subclasses

• ConstraintNavigatorData

Methods

def add_boolean_signal(self, signal_id: str, data: List[DtoBooleanDataPoint])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add boolean signal to this timeseries data context. Calling this method on an existing signal with respective type allows to add data to this signal (overriding duplicated timestamps). Trying to add data to an already existing synthesized signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

data : List[DtoBooleanDataPoint]

List of boolean data points

def add_boolean_signal_by_expression(self, signal_id: str, expression: str)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add a synthesized boolean signal to this timeseries data context. Data is created by the given expression from already added signals. Check UserGuide to see how expressions can be used. Trying to add an already existing signal or invalid expression usage will result in an exception.

Parameters

signal_id : str

Signal-ID as string

expression : str

Expression defining boolean data

def add_boolean_signal_with_availability(self, signal_id: str, data: List[DtoBooleanDataPointWithAvailability])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add boolean signal (with availabilities) to this timeseries data context. Calling this method on an existing signal with respective type allows to add data to this signal (overriding duplicated timestamps). Trying to add data to an already existing synthesized signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

data : List[DtoBooleanDataPointWithAvailability]

List of boolean data points

def add_float_signal(self, signal_id: str, data: List[DtoFloatDataPoint])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add float signal to this timeseries data context. Calling this method on an existing signal with respective type allows to add data to this signal (overriding duplicated timestamps). Trying to add data to an already existing synthesized signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

data : List[DtoFloatDataPoint]

List of float data points

def add_float_signal_by_expression(self, signal_id: str, expression: str)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add a synthesized float signal to this timeseries data context. Data is created by the given expression from already added signals. Check UserGuide to see how expressions can be used. Trying to add an already existing signal or invalid expression usage will result in an exception.

Parameters

signal_id : str

Signal-ID as string

expression : str

Expression defining float data

def add_float_signal_with_availability(self, signal_id: str, data: List[DtoFloatDataPointWithAvailability])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add float signal (with availabilities) to this timeseries data context. Calling this method on an existing signal with respective type allows to add data to this signal (overriding duplicated timestamps). Trying to add data to an already existing synthesized signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

data : List[DtoFloatDataPointWithAvailability]

List of float data points

def add_string_signal(self, signal_id: str, data: List[DtoStringDataPoint])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add string signal (with availabilities) to this timeseries data context. Calling this method on an existing signal with respective type allows to add data to this signal (overriding duplicated timestamps). Trying to add data to an already existing synthesized signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

data : List[DtoStringDataPoint]

List of string data points

def add_string_signal_by_expression(self, signal_id: str, expression: str)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add a synthesized string signal to this timeseries data context. Data is created by the given expression from already added signals. Check UserGuide to see how expressions can be used. Trying to add an already existing signal or invalid expression usage will result in an exception.

Parameters

signal_id : str

Signal-ID as string

expression : str

Expression defining string data

def add_string_signal_with_availability(self, signal_id: str, data: List[DtoStringDataPointWithAvailability])

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Add string signal (with availabilities) to this timeseries data context. Calling this method on an existing signal with respective type allows to add data to this signal (overriding duplicated timestamps). Trying to add data to an already existing synthesized signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

data : List[DtoStringDataPointWithAvailability]

List of string data points

def destroy(self)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Destroy this timeseries data context and all its data. It's always safe to destroy a data context. Internally the destruction only takes place after all references to this context have been released.

def get_boolean_signal(self, signal_id: str) ‑> List[DtoBooleanDataPoint]

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Get boolean data of a signal with given signal_id from this timeseries data context. Requesting a non-existing signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

Returns

List[DtoBooleanDataPoint]

List of boolean data points

def get_expression_info(self, signal_id: str) ‑> DtoExpressionInfo

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Get expression info of a synthesized signal with given signal_id from this timeseries data context. Requesting a non-existing or non-synthesized signal will result in an exception. DtoExpressionInfo contains a list of IDs of all involved signals, that have been used to create this signal's data.

Parameters

signal_id : str

Signal-ID as string

Returns

DtoExpressionInfo

Information about involved signals

def get_float_signal(self, signal_id: str) ‑> List[DtoFloatDataPoint]

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Get float data of a signal with given signal_id from this timeseries data context. Requesting a non-existing signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

Returns

List[DtoFloatDataPoint]

List of float data points

def get_string_signal(self, signal_id: str) ‑> List[DtoStringDataPoint]

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Get string data of a signal with given signal_id from this timeseries data context. Requesting a non-existing signal or a signal of wrong type will result in an exception.

Parameters

signal_id : str

Signal-ID as string

Returns

List[DtoStringDataPoint]

List of string data points

def read_files(self, config_json: str)

@FlavourRequirement([Flavour.FULL, Flavour.INFERENCE])

Read and ingest files to timeseries data context.

Parameters

config_json : str

DtoTimeseriesFilesReaderConfig as JSON string