RampSegment¶

class RampSegment¶

Returned by

SignalApi.CreateRampSegment

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

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

GetStart()¶

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

Return type:: float
Returns:: the start value

GetStartExpression()¶

Returns the start value expression.

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

GetStartSymbol()¶

Returns the SymbolType object of the segment start value.

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

GetStop()¶

Returns the stop value of the segment.

Return type:: float
Returns:: the stop value

GetStopExpression()¶

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

Return type:: str
Returns:: the stop expression

GetStopSymbol()¶

Returns the SymbolType object of the segment stop value.

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

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

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

SetStart(start)¶

Sets the start value of the segment.

Parameters:

start : float¶: the start value

SetStartExpression(expression)¶

Sets the start value of the segment to the given expression. The expression needs to conform to the ASAM XIL GES syntax for ConstSymbol expressions.

Parameters:

expression : str¶: the expression

SetStartSymbol(value)¶

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

Parameters:

value¶: the start value symbol

SetStop(stop)¶

Set the stop value of the segment.

Parameters:

stop : float¶: the stop value

SetStopExpression(expression)¶

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

Parameters:

expression : str¶: the expression

SetStopSymbol(value)¶

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

Parameters:

value¶: the stop value symbol