LoopSegment¶
- class LoopSegment¶
Returned by
- AppendSegment(signalSegment)¶
Appends a segment to the LoopSegment
- Parameters:
- signalSegment¶
The signalSegment
- 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 current duration of the signal segment.
- Returns:
The duration
- Return type:
float
- GetDurationExpression()¶
Returns the duration expression of the segment that is conform to the ASAM XIL GES syntax for ConstSymbol expressions.
- Return type:
str
- Returns:
the duration expression
- GetFinalValue()¶
Returns the final value of the signal segment.
- Returns:
the final value
- Return type:
float
- GetFirstValue()¶
Returns the first value of the segment.
- Returns:
the first value or NaN
- Return type:
float
- GetLoopCount()¶
Returns the No. of loops for the segment.
- Returns:
No. of loops
- Return type:
int
- GetName()¶
Returns the name of the signal description.
- Returns:
Signal description name
- Return type:
str
- GetSignalSegments()¶
Returns all segments of the LoopSegment
- Returns:
signalSegments
- Return type:
list[
SignalSegment]
- GetType()¶
Returns the type of the segment. (e.g. “Constant”)
- Returns:
The type
- Return type:
str
- GetValueAt(timestamp)¶
Returns the value at the given timestamp.
- Parameters:
- timestamp : float¶
The timestamp
- Returns:
the value or NaN
- Return type:
float
- RemoveSegment(signalSegment)¶
Removes a segment of the LoopSegment
- Parameters:
- signalSegment¶
The signalSegment to be removed
- SetComment(comment)¶
Sets the comment of the signal description
- Parameters:
- comment : str¶
Signal description comment
- SetDuration(duration)¶
Sets the duration of the segment in seconds.If you want to set the duration value of the segment to an expression, use SetDurationExpression instead.
- Parameters:
- duration : float¶
the segments duration
- SetDurationExpression(expression)¶
Sets the duration value as an expression. The expression needs to be conform to the ASAM XIL GES syntax for ConstSymbol expressions.
- Parameters:
- expression : str¶
the duration expression