SegmentSignalDescription¶

class SegmentSignalDescription¶

Returned by

• SignalApi.CreateSignal

AppendSegment(segment)¶

Appends a signal segment as last element.

Parameters:

segment¶

Signal segment

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:

SegmentSignalDescription

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

GetSegments()¶

Returns a list of all segments in the signal description.

Returns:

The segments

Return type:

list[SignalSegment]

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

RemoveSegment(segment)¶

Removes a signal segment.

Parameters:

segment¶

Signal segment

SetComment(comment)¶

Sets the comment of the signal description

Parameters:

comment : str¶

Signal description comment