Scanner Class

Vision™ MX280001A Spectrum Monitoring Application Programming Interface : Vision API Reference : Scanner Class

Scanner Class

Properties

Scanner.ChannelCount Property

Gets the number of channels in use in the remote spectrum monitor.

VB

Public ReadOnly Property ChannelCount() As Integer

C#

public int ChannelCount {get;}

C++

public int ChannelCount {get;}

Scanner.Connected Property

Gets the connection status of the remote spectrum monitor.

VB

Public ReadOnly Property Connected() As Boolean

C#

public bool Connected {get;}

C++

public bool Connected {get;}

Scanner.FileDelimiter Property

Gets or sets the file delimiter character used in the output file to separate fields in each record.

VB

Public Property FileDelimiter() As Delimiters

C#

public Delimiters FileDelimiter {get; set;}

C++

public Delimiters FileDelimiter {get; set;}

Scanner.FileViewer Property

Gets the File Viewer status or or sets the File Viewer to open the current CPM log file to view its contents.

VB

Public Property FileViewer() As ViewModes

C#

public ViewModes FileViewer {get; set;}

C++

public ViewModes FileViewer {get; set;}

Scanner.MaxFileSize Property

Gets or sets the maximum file size of the current CPM log file.

VB

Public Property MaxFileSize() As Long

C#

public long MaxFileSize {get; set;}

C++

public long MaxFileSize {get; set;}

Scanner.MinimumFreeSpace Property

Gets or sets the maximum free space of the current CPM log file.

VB

Public Property MinimumFreeSpace() As Integer

C#

public int MinimumFreeSpace {get; set;}

C++

public int MinimumFreeSpace {get; set;}

Scanner.ReloadCPC Property

Gets or sets the CPC file format for saving configuration files.

VB

Public Property ReloadCPC() As Boolean

C#

public bool ReloadCPC {get; set;}

C++

public bool ReloadCPC {get; set;}

Scanner.SaveGPS Property

Gets or sets the Save GPS status.

VB

Public Property SaveGPS() As Boolean

C#

public bool SaveGPS {get; set;}

C++

public bool SaveGPS {get; set;}

Scanner.SaveOnEvent Property

Gets the Save On Event status or sets Save On Event to Never, On limit violation, or Every Sweep.

VB

Public Property SaveOnEvent() As SaveTrigger

C#

public SaveTrigger SaveOnEvent {get; set;}

C++

public SaveTrigger SaveOnEvent {get; set;}

Scanner.SaveTraces Property

Gets the Save On Event status or sets Save On Event to Never, On limit violation, or Every Sweep.

VB

Public Property SaveTraces() As Boolean

C#

public bool SaveTraces {get; set;}

C++

public bool SaveTraces {get; set;}

Scanner.ScanDelay Property

Gets or sets the Scan Delay status.

VB

Public Property ScanDelay() As Integer

C#

public int ScanDelay {get; set;}

C++

public int ScanDelay {get; set;}

Scanner.ScanOnStartup Property

Gets or sets the option for running High-Speed Port Scanner automatically every time the computer is started.

VB

Public Property ScanOnStartup() As Boolean

C#

public bool ScanOnStartup {get; set;}

C++

public bool ScanOnStartup {get; set;}

Scanner.SetOutputFolder Property

Gets the Output Folder name or sets the Output Folder name.

VB

Public Property SetOutputFolder() As String

C#

public string SetOutputFolder {get; set;}

C++

public string SetOutputFolder {get; set;}

Scanner.ShowTraces Property

Gets or sets the Show Traces status.

VB

Public Property ShowTraces() As Boolean

C#

public bool ShowTraces {get; set;}

C++

public bool ShowTraces {get; set;}

Scanner.SweepInterval Property

Gets the current sweep interval or sets a new sweep interval.

VB

Public Property SweepInterval() As Integer

C#

public int SweepInterval {get; set;}

C++

public int SweepInterval {get; set;}

Methods

Scanner.AddChannel Method

Adds new channels to the list according to the parameters.

VB

Public Sub AddChannel(ByVal Channel As String)

C#

public System.Void AddChannel(string Channel)

C++

public System.Void AddChannel(string Channel)

Parameters

Channel: The number or index of the channel to add.

Scanner.AddChannelsDialog Method

Prompts the Add Channel Dialog to add another channel to the Channel List.

VB

Public Sub AddChannelsDialog()

C#

public System.Void AddChannelsDialog()

C++

public System.Void AddChannelsDialog()

Scanner.Close Method

The program closes the Scanner Add Channel control.

VB

Public Sub Close()

C#

public System.Void Close()

C++

public System.Void Close()

Scanner.ListChannels Method

The list of Channels of the remote spectrum monitor set in Parameter.s

VB

Public Function ListChannels(Optional ByVal Hostname As String = "") As String

C#

public string ListChannels(string Hostname = "")

C++

public string ListChannels(string Hostname = "")

Parameters

Hostname: Hostname or URL of the remote spectrum monitor.

Scanner.LoadConfiguration Method

Loads the configuration file set in Parameters.

VB

Public Function LoadConfiguration(ByVal Filename As String) As Boolean

C#

public bool LoadConfiguration(string Filename)

C++

public bool LoadConfiguration(string Filename)

Parameters

Filename: Filename, including path, where the scanner configuration is to be saved.

Scanner.Pause Method

Places channel monitoring in pause mode.

VB

Public Sub Pause()

C#

public System.Void Pause()

C++

public System.Void Pause()

Scanner.RemoveAllChannels Method

Removes all pre-existing channel definitions from the Channel List.

VB

Public Sub RemoveAllChannels()

C#

public System.Void RemoveAllChannels()

C++

public System.Void RemoveAllChannels()

Scanner.RemoveChannel Method

Removes a channel definition from the Channel List set in Parameters.

VB

Public Sub RemoveChannel(ByVal ChannelIndex As Integer)

C#

public System.Void RemoveChannel(int ChannelIndex)

C++

public System.Void RemoveChannel(int ChannelIndex)

Parameters

ChannelIndex: The channel number of the channel to be removed from the channel list.

Scanner.RunCounters Method

The number of times a channel has been scanned.

VB

Public Function RunCounters() As String

C#

public string RunCounters()

C++

public string RunCounters()

Scanner.RunSummary Method

Returns a string of elapse time, number of channels scanned, number of channels failed...

VB

Public Function RunSummary() As String

C#

public string RunSummary()

C++

public string RunSummary()

Scanner.SaveConfiguration Method

Saves the configuration file set in Parameters.

VB

Public Function SaveConfiguration(ByVal Filename As String) As Boolean

C#

public bool SaveConfiguration(string Filename)

C++

public bool SaveConfiguration(string Filename)

Parameters

Filename: The name of the configuration file to be saved.

Scanner.Start Method

Begins channel monitoring.

VB

Public Sub Start()

C#

public System.Void Start()

C++

public System.Void Start()

Events

ScanEvent Event

Scans the information for channel monitoring set in Parameters.

VB

Public Event ScanEvent(ByVal Count As Integer,ByVal Rate As Single,ByVal Elapsed As TimeSpan)

C#

public event ScanEventEventHandler ScanEvent
delegate void ScanEventEventHandler(int Count,float Rate,TimeSpan Elapsed)

C++

public event ScanEventEventHandler ScanEvent
delegate void ScanEventEventHandler(int Count,float Rate,TimeSpan Elapsed)

Parameters

Count: The total of scans through the channel list.

Rate: The channel per second captured and stored.

Elapsed: Elapse time of the of the current run.

Structures

MaskDef Structure

VB

Public Structure MaskDef

C#

public struct MaskDef

C++

public struct MaskDef

ScannerChannelDefinition Structure

VB

Public Structure ScannerChannelDefinition

C#

public struct ScannerChannelDefinition

C++

public struct ScannerChannelDefinition

Fields

Level Field

Power level per mask segment.

VB

Public Level As Single

C#

public float Level

C++

public float Level

StartFreq Field

The mask Start Frequency in Hz.

VB

Public StartFreq As Double

C#

public double StartFreq

C++

public double StartFreq

StopFreq Field

The mask Stop Frequency in Hz.

VB

Public StopFreq As Double

C#

public double StopFreq

C++

public double StopFreq

Antenna Field

Active antenna port number of multiport remote spectrum monitor.

VB

Public Antenna As Integer

C#

public int Antenna

C++

public int Antenna

ChannelPower Field

Returns the Channel Power calculated for the most recent trace acquired from the active remote spectrum monitor.

VB

Public ChannelPower As Single

C#

public float ChannelPower

C++

public float ChannelPower

DeltaMarker Field

Inputs the frequency of the delta marker relative to the marker position.

VB

Public DeltaMarker As Single

C#

public float DeltaMarker

C++

public float DeltaMarker

DeltaPower Field

Returns power at the delta marker position.

VB

Public DeltaPower As Single

C#

public float DeltaPower

C++

public float DeltaPower

Description Field

Any information to describe the channel by the user.

VB

Public Description As String

C#

public string Description

C++

public string Description

DisplayPoints Field

The number of points in the trace.

VB

Public DisplayPoints As Integer

C#

public int DisplayPoints

C++

public int DisplayPoints

Hostname Field

Enter the hostname or URL address for the instrument taking measurements.

VB

Public Hostname As String

C#

public string Hostname

C++

public string Hostname

ListIndex Field

The specific number of the channel in the list.

VB

Public ListIndex As Integer

C#

public int ListIndex

C++

public int ListIndex

LowerLimit Field

A power value of the lower limit.

VB

Public LowerLimit As Single

C#

public float LowerLimit

C++

public float LowerLimit

LowerMask Field

The mask lower limit.

VB

Public LowerMask As String

C#

public string LowerMask

C++

public string LowerMask

Marker Field

The frequency position of a marker.

VB

Public Marker As Single

C#

public float Marker

C++

public float Marker

MarkerPower Field

The power at the marker position.

VB

Public MarkerPower As Single

C#

public float MarkerPower

C++

public float MarkerPower

OBW Field

Enter the Occupied Bandwidth for the most recent trace acquired from the active target receiver.

VB

Public OBW As Single

C#

public float OBW

C++

public float OBW

PassRate Field

The total number of traces in the channels, the number or traces that passed, and the pass percentage.

VB

Public PassRate As Single

C#

public float PassRate

C++

public float PassRate

PassStatus Field

Pass/Fail status when trace compared to mask.

VB

Public PassStatus As Boolean

C#

public bool PassStatus

C++

public bool PassStatus

Preamp Field

Sets the Preamp field for measurement configuration.

VB

Public Preamp As Boolean

C#

public bool Preamp

C++

public bool Preamp

RBW Field

The Resolution Bandwidth setting for the channel.

VB

Public RBW As Double

C#

public double RBW

C++

public double RBW

RefLevel Field

The Reference Level in dBm for the channel.

VB

Public RefLevel As Single

C#

public float RefLevel

C++

public float RefLevel

StartFreq Field

The sweep Start Frequency in Hz.

VB

Public StartFreq As Double

C#

public double StartFreq

C++

public double StartFreq

StopFreq Field

The sweep Stop Frequency in Hz.

VB

Public StopFreq As Double

C#

public double StopFreq

C++

public double StopFreq

TraceCount Field

The trace sweep count useful for multiple-sweep measurements.

VB

Public TraceCount As Integer

C#

public int TraceCount

C++

public int TraceCount

UpperLimit Field

Upper power limit.

VB

Public UpperLimit As Single

C#

public float UpperLimit

C++

public float UpperLimit

UpperMask Field

Upper mask definition.

VB

Public UpperMask As String

C#

public string UpperMask

C++

public string UpperMask

VBW Field

The Video bandwidth setting for the channel.

VB

Public VBW As Double

C#

public double VBW

C++

public double VBW

strTrace Field

Comma delimited string of trace data.

VB

Public strTrace As String

C#

public string strTrace

C++

public string strTrace

Enumerations

Delimiters Enumeration

Designates the column delimiter used to separate values in CPM files.

Value

Delimiters Values and Definitions
Value	Definition
Comma	Comma
Semicolon	Semi-colon
Tab	Tab character
Space	Space character

SaveModes Enumeration

Designates the file mode for the High-Speed Port Scanner.

Value

SaveModes Values and Definitions
Value	Definition
NewFile	Create a new file each time scanning starts.
Append	Append new traces to the current file when scanning starts.

SaveTrigger Enumeration

Designates the trigger (event) that causes traces in the High-Speed Port Scanner to be written to the CPM file.

Value

SaveTrigger Values and Definitions
Value	Definition
None	Nothing is written to disk file. This mode is for visual monitoring on screen.
FailsOnly	Only write results for sweeps that fail a designated mask or threshold power level.
AllResults	Write sweep results to the CPM file after each sweep. This causes very large files, especially if trace data is being saved. This is the preferred mode if the goal is to do post-processing to look for events, coverage mapping, occupancy, etc.

ViewModes Enumeration

Description: The High-Speed Port Scanner has a built-in CPM file viewer with a very basic display. Vision also includes a File Viewer specifically for looking at CPM and RSM data files. The external option provides a much richer experience. There are circumstances where the High-Speed Port Scanner is deployed as a stand-alone program without the other Vision components available. It is recommended to use the Vision File Viewer (external) when available.

ViewModes Values and Definitions
Value	Definition
Internal	High-Speed Port Scanner uses its own simple file viewer to display CPM file contents.
External	High-Speed Port Scanner uses the Vision File Viewer to open and display CPM file contents.