ScriptTraceObject¶

class ScriptTraceObject.ScriptTraceObject¶

Bases: IScriptTraceObjectMarker

Represents one TraceObject.

__str__() → str¶

property is_trace_object: bool¶

Wether the object is a valid trace object.

property task_name: str¶

The task in which the data is recorded.

Setting the task name is not allowed for the DeviceTrace.

property record_name: str¶

The name of the trace recording in the runtime.

property trigger_enabled: bool¶

Indicates whether a trigger condition has to be considered in the trace recording.

property trigger_variable: str¶

The trace signal that is used as a trigger. A complete instance path is required..

property trigger_edge: TriggerEdge¶

Defines the edge detection for triggering.

property trigger_level: object¶

Value that is reached to start the triggering. Any numeric types like int, ulong, double

(null represents the absence of a trigger level) are accepted.

Exception:

This exception is thrown if the user tries to set the trigger level with an invalid type

property post_trigger_samples: int¶

Number of records per trace variable that are buffered after triggering.

property resolution: Resolution¶

Unit of measure for the time stamp that is recorded.

property record_condition: str¶

At runtime, the application checks the recording condition. If it is fulfilled, then the trace data is buffered.

property comment: str¶

The comment of the trace recording.

property auto_start: bool¶

Persistently saves the trace configuration and the last contents of the runtime buffer to the target device. After the device has been restarted, the trace is started automatically if the trigger has not occurred yet.

property every_n_cycles: int¶

Data is recorded in every n task cycle.

property time_axis: ScriptAxisSettings¶

Contains the configuration of the time axis.

property diagrams: ScriptTraceDiagramCollection¶

Not allowed for the DeviceTrace.

property variable_list: ScriptTraceVariableList¶

Not allowed for the DeviceTrace.

open_editor() → ScriptTraceEditorObject¶

Open the trace editor for this trace object.

This is required to perform online operations like starting, stopping and downloading traces.

If the editor is already open it is focused.

This method even works if no UI is displayed.

Return type:

ScriptTraceEditorObject

Returns:

The trace editor.