Vision™ MX280001A Spectrum Monitoring Application Programming Interface : Vision API Reference : TDOAControl Class
 
TDOAControl Class
Properties
TDOAControl.AntennaChannel Property
Gets or sets the Antenna Channel set in Parameters for making TDOA measurements.
VB
Public Property AntennaChannel(ByVal Index As Integer) As Integer
C#
[System.Runtime.CompilerServices.IndexerName("AntennaChannel")]
public int this[int Index] {get; set;}
C++
[System.Runtime.CompilerServices.IndexerName("AntennaChannel")]
public int this[int Index] {get; set;}
Parameters
Index: The TDOA measurement uses 3 RSM probes for capturing I/Q data and calculating the location estimate. The probes are indexed, 0, 1, and 2.
TDOAControl.AutoReferenceLevels Property
Gets or sets the reference level amplitude value.
VB
Public Property AutoReferenceLevels() As Boolean
C#
public bool AutoReferenceLevels {get; set;}
C++
public bool AutoReferenceLevels {get; set;}
TDOAControl.AverageCount Property
Gets or sets the average count for use in calculating the average display value.
VB
Public Property AverageCount() As Integer
C#
public int AverageCount {get; set;}
C++
public int AverageCount {get; set;}
TDOAControl.AverageDistances Property
Gets or sets averaging for TDOA measurement results.
VB
Public Property AverageDistances() As Boolean
C#
public bool AverageDistances {get; set;}
C++
public bool AverageDistances {get; set;}
TDOAControl.CaptureBandwidth Property
Gets or sets the I/Q Capture data bandwidth.
VB
Public Property CaptureBandwidth() As String
C#
public string CaptureBandwidth {get; set;}
C++
public string CaptureBandwidth {get; set;}
TDOAControl.CenterFrequency Property
Gets or sets the center frequency of the active target receiver.
VB
Public Property CenterFrequency() As String
C#
public string CenterFrequency {get; set;}
C++
public string CenterFrequency {get; set;}
Property Value
Type: String. Units are expected. If no units are provided, Hz is assumed.
TDOAControl.DrawEstimateLines Property
Gets or sets status to draw estimate lines on the map.
VB
Public Property DrawEstimateLines() As Boolean
C#
public bool DrawEstimateLines {get; set;}
C++
public bool DrawEstimateLines {get; set;}
TDOAControl.DrawHeatMap Property
Gets or sets status to draw a heat map.
VB
Public Property DrawHeatMap() As Boolean
C#
public bool DrawHeatMap {get; set;}
C++
public bool DrawHeatMap {get; set;}
TDOAControl.DrawSweepTrace Property
Gets or sets status to draw graph on screen.
VB
Public Property DrawSweepTrace() As Boolean
C#
public bool DrawSweepTrace {get; set;}
C++
public bool DrawSweepTrace {get; set;}
TDOAControl.GraphMode Property
Gets the current Graph Mode or sets the Graph Mode to either 1 Probe, 3 Probes, or TDOA.
VB
Public Property GraphMode() As ChartType
C#
public ChartType GraphMode {get; set;}
C++
public ChartType GraphMode {get; set;}
TDOAControl.Latitude Property
The obtains the latitude coordinate of the remote spectrum monitor.
VB
Public ReadOnly Property Latitude() As Single
C#
public float Latitude {get;}
C++
public float Latitude {get;}
TDOAControl.Longitude Property
The longitude coordinate of the remote spectrum monitor.
VB
Public ReadOnly Property Longitude() As Single
C#
public float Longitude {get;}
C++
public float Longitude {get;}
TDOAControl.MovingAverageCount Property
Gets or sets the moving average count for use in calculating the average display value.
VB
Public Property MovingAverageCount() As Integer
C#
public int MovingAverageCount {get; set;}
C++
public int MovingAverageCount {get; set;}
TDOAControl.Preamp Property
Sets the Preamp parameter for measurement configuration.
VB
Public Property Preamp(ByVal Index As Integer) As Boolean
C#
[System.Runtime.CompilerServices.IndexerName("Preamp")]
public bool this[int Index] {get; set;}
C++
[System.Runtime.CompilerServices.IndexerName("Preamp")]
public bool this[int Index] {get; set;}
Parameters
Index: The TDOA measurement uses 3 RSM probes for capturing I/Q data and calculating the location estimate. The probes are indexed, 0, 1, and 2.
TDOAControl.ProbeDelay Property
Gets the current Probe Delay value or sets the value set by Parameters.
VB
Public Property ProbeDelay(ByVal Index As Integer) As Integer
C#
[System.Runtime.CompilerServices.IndexerName("ProbeDelay")]
public int this[int Index] {get; set;}
C++
[System.Runtime.CompilerServices.IndexerName("ProbeDelay")]
public int this[int Index] {get; set;}
Parameters
Index: The TDOA measurement uses 3 RSM probes for capturing I/Q data and calculating the location estimate. The probes are indexed, 0, 1, and 2.
TDOAControl.ProbeHostname Property
Enter the hostname or URL address for the instrument taking measurements.
VB
Public Property ProbeHostname(ByVal Index As Integer) As String
C#
[System.Runtime.CompilerServices.IndexerName("ProbeHostname")]
public string this[int Index] {get; set;}
C++
[System.Runtime.CompilerServices.IndexerName("ProbeHostname")]
public string this[int Index] {get; set;}
Parameters
Index: The TDOA measurement uses 3 RSM probes for capturing I/Q data and calculating the location estimate. The probes are indexed, 0, 1, and 2.
TDOAControl.ProbeStatus Property
Returns status of probe. True if probe is online.
VB
Public ReadOnly Property ProbeStatus(ByVal Index As Integer) As Boolean
C#
[System.Runtime.CompilerServices.IndexerName("ProbeStatus")]
public bool this[int Index] {get;}
C++
[System.Runtime.CompilerServices.IndexerName("ProbeStatus")]
public bool this[int Index] {get;}
Parameters
Index: The TDOA measurement uses 3 RSM probes for capturing I/Q data and calculating the location estimate. The probes are indexed, 0, 1, and 2.
TDOAControl.ReferenceLevel Property
Gets or sets the reference level amplitude value.
VB
Public Property ReferenceLevel(ByVal Index As Integer) As Integer
C#
[System.Runtime.CompilerServices.IndexerName("ReferenceLevel")]
public int this[int Index] {get; set;}
C++
[System.Runtime.CompilerServices.IndexerName("ReferenceLevel")]
public int this[int Index] {get; set;}
Parameters
Index: The TDOA measurement uses 3 RSM probes for capturing I/Q data and calculating the location estimate. The probes are indexed, 0, 1, and 2.
TDOAControl.ReportFolder Property
Gets or sets the name of the TDOA Report.
VB
Public Property ReportFolder() As String
C#
public string ReportFolder {get; set;}
C++
public string ReportFolder {get; set;}
TDOAControl.RunCount Property
Gets the number of used in calculated the average.
VB
Public ReadOnly Property RunCount() As Integer
C#
public int RunCount {get;}
C++
public int RunCount {get;}
TDOAControl.ShowCorrelationResults Property
Gets or sets the correlation results.
VB
Public Property ShowCorrelationResults() As Boolean
C#
public bool ShowCorrelationResults {get; set;}
C++
public bool ShowCorrelationResults {get; set;}
TDOAControl.ShowGraphs Property
Gets or sets the status of ShowGraphs.
VB
Public Property ShowGraphs() As Boolean
C#
public bool ShowGraphs {get; set;}
C++
public bool ShowGraphs {get; set;}
Property Value
true if yes; otherwise, false.
TDOAControl.ShowHelp Property
Gets or sets the status of ShowHelp. Help is displayed if status is “true”.
VB
Public Property ShowHelp() As Boolean
C#
public bool ShowHelp {get; set;}
C++
public bool ShowHelp {get; set;}
TDOAControl.ShowMap Property
Gets or sets the status of Show Map.
VB
Public Property ShowMap() As Boolean
C#
public bool ShowMap {get; set;}
C++
public bool ShowMap {get; set;}
TDOAControl.ShowMobileTracking Property
Gets or sets the status of Show Mobile Tracking.
VB
Public Property ShowMobileTracking() As Boolean
C#
public bool ShowMobileTracking {get; set;}
C++
public bool ShowMobileTracking {get; set;}
TDOAControl.ShowViewOptions Property
Gets or sets the status of Show View Options.
VB
Public Property ShowViewOptions() As Boolean
C#
public bool ShowViewOptions {get; set;}
C++
public bool ShowViewOptions {get; set;}
TDOAControl.TrackMovingTarget Property
Gets or sets the status of Track Moving Target.
VB
Public Property TrackMovingTarget() As Boolean
C#
public bool TrackMovingTarget {get; set;}
C++
public bool TrackMovingTarget {get; set;}
TDOAControl.WaitForPeak Property
Gets or sets the status of Wait For Peak.
VB
Public Property WaitForPeak() As Boolean
C#
public bool WaitForPeak {get; set;}
C++
public bool WaitForPeak {get; set;}
Methods
TDOAControl.GenerateReport Method
Activates the program to generate a TDOA report.
VB
Public Sub GenerateReport()
C#
public System.Void GenerateReport()
C++
public System.Void GenerateReport()
TDOAControl.GetParametersFromInput Method
Opens dialog input for I/Q Capture parameters.
VB
Public Sub GetParametersFromInput()
C#
public System.Void GetParametersFromInput()
C++
public System.Void GetParametersFromInput()
TDOAControl.ResetAveraging Method
Enter the channel number of the active remote spectrum monitor.
VB
Public Sub ResetAveraging()
C#
public System.Void ResetAveraging()
C++
public System.Void ResetAveraging()
TDOAControl.RunTDOA Method
Begins the TDOA application.
VB
Public Sub RunTDOA()
C#
public System.Void RunTDOA()
C++
public System.Void RunTDOA()
TDOAControl.SaveIQData Method
Saves the IQData to a file set in Parameter.
VB
Public Sub SaveIQData(Optional ByVal Filename As String = "")
C#
public System.Void SaveIQData(string Filename = "")
C++
public System.Void SaveIQData(string Filename = "")
Parameters
Filename: The name of the file that the IQData is saved.
TDOAControl.ScreenShot Method
Triggers a screen capture and places it into the clipboard.
VB
Public Function ScreenShot() As Bitmap
C#
public Bitmap ScreenShot()
C++
public Bitmap ScreenShot()
TDOAControl.VerifyProbe Method
Verifies that a probe is available and ready set by Parameters.
VB
Public Function VerifyProbe(ByVal Number As Integer) As Boolean
C#
public bool VerifyProbe(int Number)
C++
public bool VerifyProbe(int Number)
Parameters
Number: The number of the probe to be verified.
Events
CalibrateProbes Event
VB
Public Event CalibrateProbes()
C#
public event CalibrateProbesEventHandler CalibrateProbes
delegate void CalibrateProbesEventHandler()
C++
public event CalibrateProbesEventHandler CalibrateProbes
delegate void CalibrateProbesEventHandler()
TDOA_Iteration Event
Returns notification that a single TDOA measurement has been completed.
VB
Public Event TDOA_Iteration()
C#
public event TDOA_IterationEventHandler TDOA_Iteration
delegate void TDOA_IterationEventHandler()
C++
public event TDOA_IterationEventHandler TDOA_Iteration
delegate void TDOA_IterationEventHandler()
Structures
ChannelInfo Structure
VB
Public Structure ChannelInfo
C#
public struct ChannelInfo
C++
public struct ChannelInfo
Fields
Channel Field
Enter the channel number of the active remote spectrum monitor.
VB
Public Channel As Integer
C#
public int Channel
C++
public int Channel
Latitude Field
The latitude coordinate of the remote spectrum monitor.
VB
Public Latitude As Double
C#
public double Latitude
C++
public double Latitude
Longitude Field
The longitude coordinate of the remote spectrum monitor.
VB
Public Longitude As Double
C#
public double Longitude
C++
public double Longitude
ProbeName Field
Enter a name for the desired Remote Spectrum Analyzer.
VB
Public ProbeName As String
C#
public string ProbeName
C++
public string ProbeName
Ready Field
Checks status that the prober is ready for measurement.
VB
Public Ready As Boolean
C#
public bool Ready
C++
public bool Ready
URL Field
Enter a URL for the desired Remote Spectrum Analyzer.
VB
Public URL As String
C#
public string URL
C++
public string URL
Enumerations
ChartType Enumeration
Designates the Chart type to be displayed in the TDOA control. If Sweep is selected, then a trace sweep is acquired and displayed before each I/Q capture occurs. This allows the user to monitor the RF signal to verify that the component of interest is still there.
Value
 
ChartType Values and Definitions
Value
Definition
IQ
Display an I/Q plot with each TDOA measurement iteration.
Sweep
Display a sweep trace with each TDOA measurement iteration.