SawSegment¶

class SawSegment¶

Returned by

SignalApi.CreateSawSegment

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

GetAmplitude()¶

Returns the amplitude value of the segment.

Return type:: float
Returns:: the amplitude value

GetAmplitudeExpression()¶

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

Return type:: str
Returns:: the amplitude expression

GetAmplitudeSymbol()¶

Returns the SymbolType object of the segment amplitude value.

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

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

GetDutyCycle()¶

Returns the dutyCycle value of the segment.

Return type:: float
Returns:: the dutyCycle value

GetDutyCycleExpression()¶

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

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

GetDutyCycleSymbol()¶

Returns the SymbolType object of the segment dutyCycle value.

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

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

GetPeriod()¶

Returns the period value of the segment.

Return type:: float
Returns:: the period value

GetPeriodExpression()¶

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

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

GetPeriodSymbol()¶

Returns the SymbolType object of the segment period value.

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

GetPhase()¶

Returns the phase value of the segment.

Return type:: float
Returns:: the phase value

GetPhaseExpression()¶

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

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

GetPhaseSymbol()¶

Returns the SymbolType object of the segment phase value.

Return type:: SymbolType
Returns:: the phase 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

SetAmplitude(amplitude)¶

Sets the amplitude value of the segment.

Parameters:

amplitude : float¶: the amplitude value

SetAmplitudeExpression(expression)¶

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

Parameters:

expression : str¶: the amplitude expression

SetAmplitudeSymbol(value)¶

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

Parameters:

value¶: the amplitude value symbol

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

SetDutyCycle(dutyCycle)¶

Sets the dutyCycle value of the segment.

Parameters:

dutyCycle : float¶: the dutyCycle value

SetDutyCycleExpression(expression)¶

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

Parameters:

expression : str¶: the dutyCycle expression

SetDutyCycleSymbol(value)¶

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

Parameters:

value¶: the dutyCycle value symbol

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

SetPeriod(period)¶

Sets the period value of the segment.

Parameters:

period : float¶: the period value

SetPeriodExpression(expression)¶

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

Parameters:

expression : str¶: the period expression

SetPeriodSymbol(value)¶

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

Parameters:

value¶: the period value symbol

SetPhase(phase)¶

Sets the phase value of the segment.

Parameters:

phase : float¶: the phase value

SetPhaseExpression(expression)¶

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

Parameters:

expression : str¶: the phase expression

SetPhaseSymbol(value)¶

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

Parameters:

value¶: the phase 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