Occupancy Class

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

Occupancy Class

Properties

Occupancy.AntennaPort Property

Gets or sets the antenna port of the of the remote spectrum monitor.

Public Property AntennaPort() As Integer

public int AntennaPort {get; set;}

C++

public int AntennaPort {get; set;}

Occupancy.ArchiveFolder Property

Gets or sets the archive folder period.

Public Property ArchiveFolder() As String

public string ArchiveFolder {get; set;}

C++

public string ArchiveFolder {get; set;}

Occupancy.ChannelWidth Property

Gets or sets the channel width for the Occupancy report. Channel width is the frequency width of each sub-channel. The overall frequency span of the trace sweeps will be divided into bins of this width, and the power level in each bin will determine the occupancy for that channel.

Public Property ChannelWidth() As Long

public long ChannelWidth {get; set;}

C++

public long ChannelWidth {get; set;}

Occupancy.GroupByResult Property

Gets or sets the option for creating a group of sub-channels based of pass/fail status.

Public Property GroupByResult() As Boolean

public bool GroupByResult {get; set;}

C++

public bool GroupByResult {get; set;}

Occupancy.IncludeDetails Property

Gets Include Details status. If true, the occupancy report will be considerably longer, as more details will be included.

Public Property IncludeDetails() As Boolean

public bool IncludeDetails {get; set;}

C++

public bool IncludeDetails {get; set;}

Occupancy.Report Property

Creates the occupancy report and saves it under the filename specified in the input parameter. The extension of the file determines the file type -HTM or CSV.

Public ReadOnly Property Report(ByVal OutputFile As String) As String

[System.Runtime.CompilerServices.IndexerName("Report")]
public string this[string OutputFile] {get;}

C++

[System.Runtime.CompilerServices.IndexerName("Report")]
public string this[string OutputFile] {get;}

Parameters

OutputFile: The filename to save the report under. This may include a full path description. The file extension should be either .csv or .htm,. The extension determines the output format of the report.

Occupancy.StartFrequency Property

Gets or sets the start frequency at which to begin the occupancy report. This does not have to coincide with the start frequency of the trace data stored in the selected database(s).

Public Property StartFrequency() As Long

public long StartFrequency {get; set;}

C++

public long StartFrequency {get; set;}

Occupancy.StopFrequency Property

Gets or sets Stop Frequency at which to begin the occupancy report.

Public Property StopFrequency() As Long

public long StopFrequency {get; set;}

C++

public long StopFrequency {get; set;}

Occupancy.Threshold Property

Gets or sets the power threshold level.

Public Property Threshold() As Single

public float Threshold {get; set;}

C++

public float Threshold {get; set;}

Occupancy.ThresholdType Property

Gets or sets the Threshold Type as maximum, minimum or average power in the channel.

Public Property ThresholdType() As Integer

public int ThresholdType {get; set;}

C++

public int ThresholdType {get; set;}

Methods

Occupancy.LoadOwnerList Method

Sets the name for the Owner List in the Occupancy Report. The Owner List is the last column for each sub-channel. The Owner List is loaded from a file. The file is plain text, and should have two comma separated columns, the first column contains the frequency center for a sub-channel (in MHz). The second column contains the text description of that sub-channel.

The Owner List can be saved and loaded, but it is not stored in the Vision database, so you will have to reload it each time you want to create an occupancy report with channel owners listed.

It may be easiest to start the list using the Vision Occupancy Report generator. Simply click in the last column of the report after it is generated and enter the description. Once you save the report, you can edit it further in a text editor or spreadsheet, as long as the format is preserved when saved.

Public Function LoadOwnerList(ByVal Filename As String) As String

public string LoadOwnerList(string Filename)

C++

public string LoadOwnerList(string Filename)

Parameters

Filename: Filename of the owner list.


	Anritsu Company 1-800-ANRITSU 10450-00062, Rev. M