xPC Target

Scope Object Properties

Scope object properties let you select signals to acquire, set triggering modes, and access signal information from the target application. You can view and change these properties using scope object methods

The properties for a scope object are listed in the following table. This table includes a description of the properties and which properties you can change directly by assigning a value.

Property	Description	Write
Application	Name of the Simulink model associated to this scope object.
ScopeId	A numeric index unique for each scope.
Status	Indicate whether data is being acquired, the scope is waiting for a trigger, the scope has been stopped (interrupted), or acquisition is finished. Values are 'Acquiring', 'Ready for being Triggered', 'Interrupted', and 'Finished'.
Type	Determine whether the scope is displayed on the host computer or on the target computer. Values are 'host' and 'target'.
NumSamples	Number of contiguous samples captured during the acquisition of a data package.	Yes
NumPrePostSamples	Number of samples collected before or after a trigger event. The default value is 0. Entering a negative value collects samples before the trigger event. Entering a positive value collects samples after the trigger event. If you set TriggerMode to FreeRun, this property has no effect on data acquisition.
Decimation	A number n, where every nth sample is acquired in a scope window. Note This value is the same as Interleave in a scope window.	Yes
TriggerMode	Trigger mode for a scope. Valid values are 'FreeRun' (default), 'Software', 'Signal', and 'Scope'.	Yes
TriggerSignal	If TriggerMode='Signal', identifies which block output signal to use for triggering the scope. You identify the signal with a signal index from the target object property Signal.	Yes
TriggerSample	If TriggerMode='Scope', then TriggerSample specifies which sample of the triggering scope the current scope should trigger on. For example, if TriggerSample = 0 (default), the current scope will trigger on sample 0 (first sample acquired) of the triggering scope. This means that the two scopes will be perfectly synchronized. If TriggerSample = 1, the first sample (sample 0) of the current scope will be the at the same instant as sample number 1 (second sample in the acquisition cycle) of the triggering scope. As a special case, setting TriggerSample to -1 means that the current scope will be triggered at the end of the acquisition cycle of the triggering scope. Thus, the first sample acquired of the triggering scope will be the one sample after the last sample of the triggering scope.
TriggerLevel	If TriggerMode='Signal', indicates the value the signal has to cross to trigger the scope and start acquiring data. The trigger level can be crossed with either a rising or falling signal.	Yes
TriggerSlope	If TriggerMode='Signal', indicates whether the trigger is on a rising or falling signal. Values are 'Either' (default), 'Rising', or 'Falling'.	Yes
TriggerScope	If TriggerMode='Scope', identifies which scope to use for a trigger. A scope can be set to trigger when another scope is triggered. This is done by setting the slave scope property TriggerScope to the scope index of the master scope.	Yes
Mode	Indicate how a scope displays the signals. Values are 'Numerical', 'Redraw' (default), 'Sliding', or 'Rolling'.	Yes
YLimit	Minimum and maximum y-axis values. This property can be set to 'auto'.	Yes
Grid	Values are 'on' or 'off'.	Yes
StartTime	Time within the total execution time, when a scope begins acquiring a data package.
Time	Contains the time data for a single data package from a scope.
Data	Contains the output data for a single data package from a scope.
Signals	List of signal indices from the target object to display on the scope.

What Is a Scope Object?

Scope Object Methods