RampSlopeSegment¶

class RampSlopeSegment¶

Returned by

SignalApi.CreateRampSlopeSegment

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

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

GetOffset()¶

Returns the offset value of the segment.

Return type:: float
Returns:: the offset value

GetOffsetExpression()¶

Returns the offset value expression. The expression conforms to the ASAM XIL GES syntax for ConstSymbol expressions.

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

GetOffsetSymbol()¶

Returns the SymbolType object of the segment offset value.

Return type:: SymbolType
Returns:: the offset value symbol

GetSlope()¶

Returns the slope value of the segment.

Return type:: float
Returns:: the slope value

GetSlopeExpression()¶

Returns the slope value expression. The expression conforms to the ASAM XIL GES syntax for ConstSymbol expressions.

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

GetSlopeSymbol()¶

Returns the SymbolType object of the segment slope value.

Return type:: SymbolType
Returns:: the slope value symbol

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

GetValueAt(timestamp)¶

Returns the value at the given timestamp.

Parameters:

timestamp : float¶: The timestamp

Returns:

the value or NaN

Return type:

float

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

SetOffset(offset)¶

Sets the offset value of the segment.

Parameters:

offset : float¶: the offset value

SetOffsetExpression(expression)¶

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

Parameters:

expression : str¶: the expression

SetOffsetSymbol(value)¶

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

Parameters:

value¶: the offset value symbol

SetSlope(slope)¶

Sets the slope value of the segment.

Parameters:

slope : float¶: the slope value

SetSlopeExpression(expression)¶

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

Parameters:

expression : str¶: the expression

SetSlopeSymbol(value)¶

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

Parameters:

value¶: the slope value symbol

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