Main Content

getCursorInfo

Return settings for Logic Analyzer cursor

Description

example

cursorInfo = getCursorInfo(scope,'CursorTag',tag) returns the settings for the cursor or cursors specified by the input tag.

Examples

collapse all

This example shows how to use functions to create, manipulate, and delete cursors in a dsp.LogicAnalyzer object.

Create Logic Analyzer and Signals

scope = dsp.LogicAnalyzer('NumInputPorts',3);
for ii = 1:20
    scope(ii,10*ii,20*ii);
end

Add Cursor

Add a cursor at 15 seconds and show the cursor information.

cursor = addCursor(scope,'Location',15,'Color','Cyan');
getCursorInfo(scope,cursor)
ans = struct with fields:
    Location: 15
       Color: [0 1 1]
      Locked: 0
         Tag: 'C2'

Modify Cursor

Change the cursor color to magenta.

hide(scope)
modifyCursor(scope,cursor,'Color','Magenta')
show(scope)

Remove Cursor

Delete the yellow cursor at 0 seconds.

hide(scope)
tags = getCursorTags(scope);
deleteCursor(scope,tags{1});
show(scope)

Input Arguments

collapse all

The Logic Analyzer object from which you want to return cursor settings, specified as a handle to the dsp.LogicAnalyzer object.

The tag or tags identifying the cursor or cursors about which to get information, specified as the randomly assigned cursor tag or tags.

Example: 'C5'

Example: {'C4','C5'}

Example: ["C4","C5"]

Data Types: char | cell | string

Output Arguments

collapse all

The cursorInfo struct contains the following fields:

  • Location — Location of the cursors

  • Color — Color of the cursors

  • Locked — Locked status of the cursors

  • Tag — Tag identifying cursors

Version History

Introduced in R2013a