Vision™ MX280001A Spectrum Monitoring Application Programming Interface : Vision API Reference : Database Class
 
Database Class
Methods
Database.AddChannel Method
Adds new channels to the list according to the parameters.
VB
Public Function AddChannel(ByVal cInfo As ChannelDescription) As Boolean
C#
public bool AddChannel(ChannelDescription cInfo)
C++
public bool AddChannel(ChannelDescription cInfo)
Parameters
cInfo: Channel description of the channel to add, contained in ChannelDesription structure.
Database.AddProbe Method
Enters a new probe into the database with the parameter pInfo.
VB
Public Function AddProbe(ByVal pInfo As ProbeDescription) As Boolean
C#
public bool AddProbe(ProbeDescription pInfo)
C++
public bool AddProbe(ProbeDescription pInfo)
Parameters
pInfo: Description of the probe to add, as contained in the ProbeDescription structure.
Database.CreateEmptyDatabase Method
Creates a new database set in parameters.
VB
Public Function CreateEmptyDatabase(ByVal TargetPath As String) As Boolean
C#
public bool CreateEmptyDatabase(string TargetPath)
C++
public bool CreateEmptyDatabase(string TargetPath)
Parameters
TargetPath: Full path in the local file system where the database is to be created. Do not include a file name. If a Vision database already exists at this location, it will be overwritten.
Database.DeleteChannel Method
Deletes the specified channel of the remote spectrum monitor set in parameters from the database.
VB
Public Function DeleteChannel(ByVal ProbeName As String,ByVal ChannelNumber As Integer) As Boolean
C#
public bool DeleteChannel(string ProbeName,int ChannelNumber)
C++
public bool DeleteChannel(string ProbeName,int ChannelNumber)
Parameters
ProbeName: Probe name containing the channel to delete.
ChannelNumber: The antenna port number on a multi-port target receiver.
Database.DeleteProbe Method
Deletes the specified remote spectrum monitor set in parameters from the database.
VB
Public Function DeleteProbe(ByVal ProbeName As String) As Boolean
C#
public bool DeleteProbe(string ProbeName)
C++
public bool DeleteProbe(string ProbeName)
Parameters
ProbeName: Name of the target receiver to delete from the database.
Database.GetChannel Method
Obtains the specified channel of the remote spectrum monitor set in parameters from the database.
VB
Public Function GetChannel(ByVal ProbeName As String,ByVal ChannelNumber As Integer) As ChannelDescription
C#
public ChannelDescription GetChannel(string ProbeName,int ChannelNumber)
C++
public ChannelDescription GetChannel(string ProbeName,int ChannelNumber)
Parameters
ProbeName: Name of the target receiver for the desired channel.
ChannelNumber: Channel number to retrieve.
Database.GetDatabasePath Method
Obtains the database path.
VB
Public Function GetDatabasePath() As String
C#
public string GetDatabasePath()
C++
public string GetDatabasePath()
Database.GetProbe Method
Gets the specified remote spectrum monitor from the database set in parameters.
VB
Public Function GetProbe(ByVal ProbeName As String) As ProbeDescription
C#
public ProbeDescription GetProbe(string ProbeName)
C++
public ProbeDescription GetProbe(string ProbeName)
Parameters
ProbeName: Name of the probe to retrieve.
Database.GetTraces Method
Gets the traces of the specified channel and remote spectrum monitor set in parameters from the database.
 
VB
Public Function GetTraces(ByVal ProbeName As String,ByVal Channel As Integer) As ChannelData
C#
public ChannelData GetTraces(string ProbeName,int Channel)
C++
public ChannelData GetTraces(string ProbeName,int Channel)
Parameters
ProbeName: Name of a probe in the Vision database.
Channel: The channel to retrieve.
Database.ModifyChannel Method
Modifies the database content set in Parameters.
VB
Public Function ModifyChannel(ByVal ProbeName As String,ByVal cInfo As ChannelDescription) As Boolean
C#
public bool ModifyChannel(string ProbeName,ChannelDescription cInfo)cc
C++
public bool ModifyChannel(string ProbeName,ChannelDescription cInfo)
Parameters
ProbeName: Name of a probe in the Vision database.
cInfo: New channel description in a ChannelDescription structure.
Database.ModifyProbe Method
Modifies the probe definition set in Parameters.
VB
Public Function ModifyProbe(ByVal pInfo As ProbeDescription) As Boolean
C#
public bool ModifyProbe(ProbeDescription pInfo)
C++
public bool ModifyProbe(ProbeDescription pInfo)
Parameters
pInfo: A probeDescription structure containing the new probe parameters.
Database.ProbeList Method
Obtains the list of remote spectrum monitors from the database.
VB
Public Function ProbeList() As List(Of ProbeDescription)
C#
public List<ProbeDescription> ProbeList()
C++
public List<ProbeDescription> ProbeList()
Database.SetDatabasePath Method
Sets the location of the database set in parameters.
VB
Public Function SetDatabasePath(ByVal Path As String) As Boolean
C#
public bool SetDatabasePath(string Path)
C++
public bool SetDatabasePath(string Path)
Parameters
Path: Full path to the Vision database. This is the folder name only, do not include a file name.
Structures
ChannelData Structure
VB
Public Structure ChannelData
C#
public struct ChannelData
C++
public struct ChannelData
ProbeDescription Structure
VB
Public Structure ProbeDescription
C#
public struct ProbeDescription
C++
public struct ProbeDescription
Fields
CarrierFreq Field
Enter the carrier frequency.
VB
Public CarrierFreq As Long
C#
public long CarrierFreq
C++
public long CarrierFreq
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
Failed Field
Enters a failed status.
VB
Public Failed As Integer
C#
public int Failed
C++
public int Failed
Passed Field
Enters a passed status.
VB
Public Passed As Integer
C#
public int Passed
C++
public int Passed
ProbeName Field
Enter a name for the desired Remote Spectrum Analyzer.
VB
Public ProbeName As String
C#
public string ProbeName
C++
public string ProbeName
RefLevel Field
The Reference Level in dBm for the channel.
VB
Public RefLevel As Single()
C#
public float[] RefLevel
C++
public float[] RefLevel
Sector Field
The sector of an antenna in relation to North.
VB
Public Sector As Integer
C#
public int Sector
C++
public int Sector
StartFreq Field
The sweep Start Frequency in Hz.
VB
Public StartFreq As Double()
C#
public double[] StartFreq
C++
public double[] StartFreq
Status Field
Pass/Fail status when trace compared to mask.
VB
Public Status As Boolean()
C#
public bool[] Status
C++
public bool[] Status
StopFreq Field
The sweep Stop Frequency in Hz.
VB
Public StopFreq As Double()
C#
public double[] StopFreq
C++
public double[] StopFreq
Times Field
An array of time stamps. Each time stamp corresponds to the trace of the same index in the Traces array field of this structure.
VB
Public Times As String()
C#
public string[] Times
C++
public string[] Times
TraceCount Field
The trace sweep count useful for multiple-sweep measurements.
VB
Public TraceCount As Integer
C#
public int TraceCount
C++
public int TraceCount
TraceTable Field
The name of the trace table.
VB
Public TraceTable As String
C#
public string TraceTable
C++
public string TraceTable
Traces Field
Returns all traces in the database for the selected channel.
VB
Public Traces As String()
C#
public string[] Traces
C++
public string[] Traces
URL Field
Enter the URL of the selected remote spectrum monitor.
VB
Public URL As String
C#
public string URL
C++
public string URL
Structures
ChannelDescription Structure
VB
Public Structure ChannelDescription
C#
public struct ChannelDescription
C++
public struct ChannelDescription
Fields
Active Field
Boolean parameter that indicates if the channel is actively scanned by Vision Acquire.
VB
Public Active As Boolean
C#
public bool Active
C++
public bool Active
Averaging Field
Parameter that indicates if the channel is set to Averaging Mode.
VB
Public Averaging As Integer
C#
public int Averaging
C++
public int Averaging
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
ChannelDelay Field
A calibration setting for doing TDOA measurements.
VB
Public ChannelDelay As Integer
C#
public int ChannelDelay
C++
public int ChannelDelay
Direction Field
If this is a directional antenna, perhaps a sector on a cell phone tower, for instance, this value indicates the direction angle from true north for the center line of the antenna sector. Due East is at 90 degrees.
VB
Public Direction As Integer
C#
public int Direction
C++
public int Direction
FFT Field
Sets the FFT field for measurement configuration.
VB
Public FFT As Boolean
C#
public bool FFT
C++
public bool FFT
FailRate Field
The number of traces that failed.
VB
Public FailRate As Single
C#
public float FailRate
C++
public float FailRate
Frequency Field
A frequency for which the channel is purposed for.
VB
Public Frequency As Double
C#
public double Frequency
C++
public double Frequency
LastFail Field
Date and time of the last trace that failed.
VB
Public LastFail As Date
C#
public DateTime LastFail
C++
public DateTime LastFail
LastSweep Field
Date and time of last sweep.
VB
Public LastSweep As Date
C#
public DateTime LastSweep
C++
public DateTime LastSweep
MaskName Field
The name of the mask used to validate trace data in Vision Acquire. Masks are stored in the database, and the name used here is the name the mask has in the database.
VB
Public MaskName As String
C#
public string MaskName
C++
public string MaskName
Preamp Field
Sets the Preamp field for measurement configuration.
VB
Public Preamp As Boolean
C#
public bool Preamp
C++
public bool Preamp
ProbeName Field
Enter a name for the desired Remote Spectrum Analyzer.
VB
Public ProbeName As String
C#
public string ProbeName
C++
public string ProbeName
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
RefLevelOffset Field
The Reference Level offset in dB.
VB
Public RefLevelOffset As Single
C#
public float RefLevelOffset
C++
public float RefLevelOffset
StartFreq Field
The sweep Start Frequency in Hz.
VB
Public StartFreq As Double
C#
public double StartFreq
C++
public double StartFreq
Status Field
Pass/Fail status when trace compared to mask.
VB
Public Status As Boolean
C#
public bool Status
C++
public bool Status
StopFreq Field
The sweep Stop Frequency in Hz.
VB
Public StopFreq As Double
C#
public double StopFreq
C++
public double StopFreq
TimeOut Field
A value that sets the number of seconds Vision Acquire waits for a probe to respond before moving on.
VB
Public TimeOut As Integer
C#
public int TimeOut
C++
public int TimeOut
TraceCount Field
The trace sweep count useful for multiple-sweep measurements.
VB
Public TraceCount As Integer
C#
public int TraceCount
C++
public int TraceCount
TraceMode Field
Sets the trace mode: Normal, Averaging, Max Hold, Min Hold.
VB
Public TraceMode As Byte
C#
public byte TraceMode
C++
public byte TraceMode
TracePoints Field
The number of data points in each sweep.
VB
Public TracePoints As Integer
C#
public int TracePoints
C++
public int TracePoints
VBW Field
The Video bandwidth setting for the channel.
VB
Public VBW As Double
C#
public double VBW
C++
public double VBW
ChannelCount Field
The number of channels int the channel list.
VB
Public ChannelCount As Integer
C#
public int ChannelCount
C++
public int ChannelCount
Contact Field
The email to those monitoring the remote spectrum monitor.
VB
Public Contact As String
C#
public string Contact
C++
public string Contact
Description Field
A description of the selected remote spectrum monitor.
VB
Public Description As String
C#
public string Description
C++
public string Description
ErrorCount Field
The number of traces that failed the mask for the selected channel.
VB
Public ErrorCount As Integer
C#
public int ErrorCount
C++
public int ErrorCount
GroupName Field
The name for a group of remote spectrum monitors.
VB
Public GroupName As String
C#
public string GroupName
C++
public string GroupName
Height Field
The height location of the remote spectrum monitor.
VB
Public Height As Integer
C#
public int Height
C++
public int Height
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
LastFail Field
Date and time of the last trace that failed.
VB
Public LastFail As Date
C#
public DateTime LastFail
C++
public DateTime LastFail
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
Name Field
A name given to a remote spectrum monitor.
VB
Public Name As String
C#
public string Name
C++
public string Name
Port Field
The HTTP port number for the desired remote spectrum monitor.
VB
Public Port As Integer
C#
public int Port
C++
public int Port
Status Field
Pass/Fail status when trace compared to mask.
VB
Public Status As Byte
C#
public byte Status
C++
public byte Status
TraceDatabase Field
A name given to a trace database.
VB
Public TraceDatabase As String
C#
public string TraceDatabase
C++
public string TraceDatabase
TraceTable Field
A name given to a trace table in the trace database.
VB
Public TraceTable As String
C#
public string TraceTable
C++
public string TraceTable