ConstantSegment¶

class ConstantSegment¶

Returned by

SignalApi.CreateConstantSegment

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:: ConstantSegment

GetComment()¶

Returns the comment of the segment.

Returns:: The 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

GetStopTrigger()¶

Returns the stop trigger of the segment

Returns:: stop trigger
Return type:: str

GetTimeout()¶

Returns the timeout of the segment

Returns:: timeout
Return type:: float

GetType()¶

Returns the type of the segment. (e.g. “Constant”)

Returns:: The type
Return type:: str

GetValue()¶

Returns the value of the segment. If the value is set to an expression, the expression gets calculated. Returns nan if the value expression contains unknown parameter.

Return type:: float
Returns:: the value

GetValueAt(timestamp)¶

Returns the value at the given timestamp.

Parameters:

timestamp : float¶: The timestamp

Returns:

the value or NaN

Return type:

float

GetValueExpression()¶

Returns the expression of the value of the segment. The expression is conform to the ASAM XIL GES syntax for ConstSymbol expressions.

Return type:: str
Returns:: the value expression.

GetValueSymbol()¶

Returns the SymbolType object of the segment value.

Return type:: SymbolType
Returns:: the value symbol

RemoveStopTrigger()¶: Removes the stop trigger of the segment

RemoveTimeout()¶: Removes the timeout of the segment

SetComment(comment)¶

Sets the comment of the segment.

Parameters:

comment : str¶: The 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

SetStopTrigger(stopTrigger)¶

Sets the stop trigger of the segment

Parameters:

stopTrigger : str¶: The stop trigger

SetTimeout(timeout)¶

Sets the timeout of the segment

Parameters:

timeout : float¶: The timeout

SetValue(value)¶

Sets the value of the segment. If you want to set the value of the segment to an expression, use SetValueExpression instead.

Parameters:

value : float¶: the value

SetValueExpression(expression)¶

Sets the value expression of the segment. The expression has to be conform to the ASAM XIL GES syntax for ConstSymbol expressions.

Parameters:

expression : str¶: the expression

SetValueSymbol(value)¶

Sets a SymbolType object as value of the segment. If you want to set the value of the segment to an expression, use SetValueExpression instead.

Parameters:

value¶: the value symbol