OperationSignalDescription¶
- class OperationSignalDescription¶
Returned by
- AppendSignal(signal)¶
Appends a signal to the OperationSignalDescription
- Parameters:
- signal¶
The signal
- Clone()¶
Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.
- Returns:
A copy of this object
- Return type:
- GetComment()¶
Returns the comment of the signal description
- Returns:
Signal description comment
- Return type:
str
- GetDuration()¶
Returns the duration of the signal description.
- Returns:
Duration of signal description
- Return type:
float
- GetFinalValue()¶
Returns the final value of the signal description.
- Returns:
the final value
- Return type:
float
- GetFirstValue()¶
Returns the first value of the segment.
- Returns:
the first value or NaN
- Return type:
float
- GetName()¶
Returns the name of the signal description.
- Returns:
Signal description name
- Return type:
str
- GetOperation()¶
Returns the operation of the operation signal
- Returns:
The operation. ‘ADD’ or ‘MULT’
- Return type:
str
- GetSignalDescriptions()¶
Returns all signals of the OperationSignalDescription
- Returns:
signals
- Return type:
list[
SignalDescription]
- GetValueAt(timestamp)¶
Returns the value at the given timestamp. If timestamp is bigger than duration, NaN will be returned.
- Parameters:
- timestamp : float¶
The timestamp
- Returns:
the value or NaN
- Return type:
float
- RemoveSignal(signalDescription)¶
Removes a signal of the OperationSignalDescription
- Parameters:
- signalDescription¶
The signal to be removed