Vision™ MX280001A Spectrum Monitoring Application Programming Interface : Vision API Reference : Acquire Class
 
Acquire Class
The Acquire Class provides programmatic access to all of the features of Vision Acquire. Each of the properties and methods described below correspond to a function or feature in Vision acquire accessed through the Vision Acquire UI. The descriptions below are meant to show how to access these functions. Refer to the Vision User Guide.
­­­­­Properties
Acquire.ArchivePeriod Property
Gets or sets the data collection period.
VB
Public Property ArchivePeriod() As ArchivePeriods
C#
public ArchivePeriods ArchivePeriod {get; set;}
[C++]
public ArchivePeriods ArchivePeriod {get; set;}
Acquire.AutoArchive Property
Automatically archive the trace tables into the database.
VB
Public Property AutoArchive() As Boolean
C#
public bool AutoArchive {get; set;}
C++
public bool AutoArchive {get; set;}
Remarks
Next Archive will notify you when the next archiving process will take place.
Acquire.AutoClearOld Property
Removes old traces from the database.
VB
Public Property AutoClearOld() As Boolean
C#
public bool AutoClearOld {get; set;}
C++
public bool AutoClearOld {get; set;}
Remarks
Old traces are removed once each day following the first data collection after 6:00 am.
Acquire.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;}
Acquire.Database Property
Obtains the name of the database in the active remote spectrum monitor.
VB
Public ReadOnly Property Database() As String
C#
public string Database {get;}
C++
public string Database {get;}
Acquire.GetNotification Property
A Notification will be sent to email set in Parameters.
VB
Public ReadOnly Property GetNotification(ByVal Email As String) As NotifyType
C#
[System.Runtime.CompilerServices.IndexerName("GetNotification")]
public NotifyType this[string Email] {get;}
C++
[System.Runtime.CompilerServices.IndexerName("GetNotification")]
public NotifyType this[string Email] {get;}
Parameters
Email: The email address of the person or account to be notified.
Acquire.GetNotificationList Property
Obtains the list of emails to be sent Notifications.
VB
Public ReadOnly Property GetNotificationList() As List(Of String)
C#
public List<string> GetNotificationList {get;}
C++
public List<string> GetNotificationList {get;}
Acquire.IsRunning Property
Returns a Boolean value indicating True if Vision Acquire is currently running on the same PC; or False if Vision Acquire is not running. This does not indicate the sweeping state, just whether or not the program is running. If True, then you can safely use other Acquire properties and methods to interact with Vision Acquire.
VB
Public ReadOnly Property IsRunning() As Boolean
C#
public bool IsRunning {get;}
C++
public bool IsRunning {get;}
Acquire.NotificationCount Property
Gets the number of notifications in the notification list.
VB
Public ReadOnly Property NotificationCount() As Integer
C#
public int NotificationCount {get;}
C++
public int NotificationCount {get;}
Acquire.SendNotifications Property
Gets the status of send notifications or sets the command to send notification.
VB
Public Property SendNotifications() As Boolean
C#
public bool SendNotifications {get; set;}
C++
public bool SendNotifications {get; set;}
Acquire.SweepInterval Property
Gets the current sweep interval or sets a new sweep interval.
VB
Public Property SweepInterval() As String
C#
public string SweepInterval {get; set;}
C++
public string SweepInterval {get; set;}
Acquire.SweepState Property
Gets or sets the Sweep State.
VB
Public Property SweepState() As Boolean
C#
public bool SweepState {get; set;}
C++
public bool SweepState {get; set;}
Acquire.ThreadCount Property
Gets the current thread count or sets a new thread count.
VB
Public Property ThreadCount() As Integer
C#
public int ThreadCount {get; set;}
C++
public int ThreadCount {get; set;}
Remarks
The number of threads represents the number of probes under simultaneous communication. It cannot be more than the number of probes in the database.
Methods
Acquire.AddChannel2Probe Method
Adds new channels to the list according to the parameters.
VB
Public Sub AddChannel2Probe(ByVal Probename As String,ByVal Channel As ChannelInfo)
C#
public System.Void AddChannel2Probe(string Probename,ChannelInfo Channel)
C++
public System.Void AddChannel2Probe(string Probename,ChannelInfo Channel)
Parameters
Probename: The name of the probe where the channel is to be added.
Channel: A structure of type ChannelInfo that holds the description of the channel to add.
Acquire.AddGroup Method
Creates a group with the name set in parameters. Group names are used to categorize remote probes. The group name should be a descriptive name and apply to a sub-set of remote spectrum analyzers that you want to see as a set. A group name might correspond to a geographic area, the name of a technician responsible for oversight, or to a transmission or modulation type.
VB
Public Sub AddGroup(ByVal GroupName As String)
C#
public System.Void AddGroup(string GroupName)
C++
public System.Void AddGroup(string GroupName)
Parameters
GroupName: The name of a group to add.
Acquire.AddNotification Method
Adds a new notification with the parameters Email and Mode.
VB
Public Sub AddNotification(ByVal Email As String,ByVal Mode As NotifyType)
C#
public System.Void AddNotification(string Email,NotifyType Mode)
C++
public System.Void AddNotification(string Email,NotifyType Mode)
Parameters
Email: The email address of the person or account to notify.
Mode: The notification mode of type NotifyType. This indicates how often this account receives notifications.
Acquire.AddProbe2Database Method
Enters a new probe into the database with the parameter Probe.
VB
Public Sub AddProbe2Database(ByVal Probe As ProbeInfo)
C#
public System.Void AddProbe2Database(ProbeInfo Probe)
C++
public System.Void AddProbe2Database(ProbeInfo Probe)
Parameters
Probe: Probe description contained in a ProbeInfo structure
Acquire.Archive Method
Saves the current database to a different directory location.
VB
Public Sub Archive()
C#
public System.Void Archive()
C++
public System.Void Archive()
Acquire.ClearNotifications Method
Disables the send email notifications function.
VB
Public Sub ClearNotifications()
C#
public System.Void ClearNotifications()
C++
public System.Void ClearNotifications()
Acquire.Compress Method
Immediately compresses the data in the database file.
VB
Public Sub Compress()
C#
public System.Void Compress()
C++
public System.Void Compress()
Remarks
It removes the unused space created by the deletion of old traces from the database. If Vision software seems to be running unusually slow, compacting the database may be necessary.
Acquire.ConfigureEmail Method
Configure email notification with the Parameters set.
VB
Public Sub ConfigureEmail(ByVal Hostname As String,ByVal PortNumber As String,ByVal Authenticate As Boolean,ByVal UserName As String,ByVal Password As String)
C#
public System.Void ConfigureEmail(string Hostname,string PortNumber,bool Authenticate,string UserName,string Password)
C++
public System.Void ConfigureEmail(string Hostname,string PortNumber,bool Authenticate,string UserName,string Password)
Parameters
Hostname: Hostname is the outgoing server name, or URL. You will need an account on this server to send mail.
PortNumber: The port number on the mail server. This number should be provided by the mail manager.
Authenticate: Specifies if authentification is required (true), or if not (false).
UserName: The username for the registered account on the mail server that you will be using to send mail.
Password: The password corresponding to the user account you are using to send mail.
Acquire.CreateDatabase Method
Sets the directory path for the base station definition files and database files.
VB
Public Sub CreateDatabase(ByVal Path As String)
C#
public System.Void CreateDatabase(string Path)
C++
public System.Void CreateDatabase(string Path)
Parameters
Path: The full path to a directory where you would like to create a new database. This is a path name and does not include a file name. If a Vision database already exists at this location, it will be overwritten.
Acquire.DeleteNotification Method
Deletes the email address set in parameters.
VB
Public Sub DeleteNotification(ByVal Email As String)
C#
public System.Void DeleteNotification(string Email)
C++
public System.Void DeleteNotification(string Email)
Parameters
Email: The email address of the person or account to be modified.
Acquire.LoadDatabase Method
Loads the contents of a base station definition file (.def) set in parameters into the Vision database.
VB
Public Sub LoadDatabase(_ByVal Databasename As String)
C#
public System.Void LoadDatabase(string Databasename)
C++
public System.Void LoadDatabase(string Databasename)
Parameters
Databasename: The full path to a directory where you would like to create a new database. This is a path name and does not include a file name. If a Vision database already exists at this location, it will be overwritten.
Acquire.ModifiyChannel Method
Modify a channel set in Parameters.
VB
Public Sub ModifiyChannel(ByVal Probename As String,ByVal Port As Integer,ByVal Channel As ChannelInfo)
C#
public System.Void ModifiyChannel(string Probename,int Port,ChannelInfo Channel)
C++
public System.Void ModifiyChannel(string Probename,int Port,ChannelInfo Channel)
Parameters
Probename: The name of the probe to be modified.
Port: The port number or antenna channel to modify. Ports or channel typically refer to the antenna port on a multi-port target receiver files.
Channel: Channel description loaded into a ChannelInfo structure.
Acquire.ModifyProbeDefinition Method
Select and modify the probe settings with Parameters.
VB
Public Sub ModifyProbeDefinition(ByVal Probename As String,ByVal Probe As ProbeInfo)
C#
public System.Void ModifyProbeDefinition(string Probename,ProbeInfo Probe)
C++
public System.Void ModifyProbeDefinition(string Probename,ProbeInfo Probe)
Parameters
Probename: The name of the probe to be modified.
Probe: The complete new description of the probe as contained in the ProbeInfo structure.
Acquire.RemoveGroup Method
Deletes a remote spectrum monitor Group set by Parameters from the database.
VB
Public Sub RemoveGroup(ByVal GroupName As String)
C#
public System.Void RemoveGroup(string GroupName)
C++
public System.Void RemoveGroup(string GroupName)
Parameters
GroupName: The name of the group to remove from the database. Any probes that are assigned to this group will become orphans. They will show up in the probe list in Vision Monitor, but will not be listed under a particular group name.
Acquire.RemoveProbeFromDatabase Method
Deletes a remote spectrum monitor, set in Parameters, from the database.
VB
Public Sub RemoveProbeFromDatabase(ByVal ProbeName As String)
C#
public System.Void RemoveProbeFromDatabase(string ProbeName)
C++
public System.Void RemoveProbeFromDatabase(string ProbeName)
Parameters
ProbeName: The name of an target receiver to be deleted from the database. This will delete all trace history. If you want to preserve the trace history, make a copy of the database before removing the probe. You can make a copy by Archiving the database.
Acquire.SetNotification Method
Sets email notification with Parameters.
VB
Public Sub SetNotification(ByVal Email As String,ByVal Mode As NotifyType)
C#
public System.Void SetNotification(string Email,NotifyType Mode)
C++
public System.Void SetNotification(string Email,NotifyType Mode)
Parameters
Email: The email address of the person or account to be modified.
Mode: The new notification mode for this email address.
Acquire.StartSweeping Method
Begin collection of traces to the database.
VB
Public Sub StartSweeping()
C#
public System.Void StartSweeping()
C++
public System.Void StartSweeping()
Acquire.StopSweeping Method
End collection of traces to the database.
VB
Public Sub StopSweeping()
C#
public System.Void StopSweeping()
C++
public System.Void StopSweeping()
Acquire.SweepOnce Method
Makes an immediate single sweep of the remote spectrum monitors.
VB
Public Sub SweepOnce()
C#
public System.Void SweepOnce()
C++
public System.Void SweepOnce()
Acquire.TestNotification Method
Sends a test email to the probe set in Parameters. This is used to test the notification set up and configuration. You must have already specified the email server configuration using the Configure Email method.
VB
Public Sub TestNotification(ByVal Address As String)
C#
public System.Void TestNotification(string Address)
C++
public System.Void TestNotification(string Address)
Parameters
Address: The email address at which you want to receive a test email from Vision.
Acquire.Trim Method
Removes old traces from the database immediately.
VB
Public Sub Trim()
C#
public System.Void Trim()
C++
public System.Void Trim()
Remarks
This function trims the database so there are about 2000 traces per channel. If you have fewer traces in the database, no changes will be made. If Vision software seems to be running unusually slow, compacting the database may be necessary.
Acquire.ViewLog Method
Opens Vision Log Viewer which contains the activity between the Vision Acquire software and the remote spectrum monitors.
VB
Public Sub ViewLog()
C#
public System.Void ViewLog()
C++
public System.Void ViewLog()
Remarks
If opened and a sweep is occurring, real-time data can be viewed.
Structures
ChannelInfo Structure
VB
Public Structure ChannelInfo
C#
public struct ChannelInfo
C++
public struct ChannelInfo
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
Remarks
Setting this to true will cause the corresponding channel to sweep and for the trace data to be stored each time Vision Acquire does a pass through all of the channels in the active database. If Scanning is turned off in Vision Acquire, this does not turn it on, so it does not guarantee that the channel will actually be scanned.
Antenna Field
Active antenna port number of multiport remote spectrum monitor.
VB
Public Antenna As Integer
C#
public int Antenna
C++
public int Antenna
ChannelDelay Field
A calibration setting for doing TDOA measurements.
VB
Public ChannelDelay As Single
C#
public float ChannelDelay
C++
public float ChannelDelay
Remarks
This field holds a time in nanoseconds that represents the time it takes from when a signal hits the antenna until it is time stamped internally. The timing is very important for TDOA measurements. The Channel Delay comes from several factors, such as antenna cable length, GPS antenna location relative to the RF antenna and the GPS cable length. It also includes a small contribution due to internal manufacturing or component difference from probe to probe. This value is typically calculated and set by the TDOA calibration routine.
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
Frequency Field
A frequency for which the channel is purposed for.
VB
Public Frequency As Single
C#
public float Frequency
C++
public float Frequency
Remarks
This value does not affect the sweep parameters of the remote probe. It is used to verify that two probes are at the same frequency for interference hunting. This is typically the center frequency where the probe is sweeping. A multiport probe might have 12 antenna ports, arranged in sets of three for different sectors monitoring different signals on a single tower. Perhaps monitoring LTE, GSM and WCDMA. When Vision is asked to do certain measurements, such as Power on Arrival, it wants to verify that the channels selected actually are looking at the same frequency range. Someone may adjust the start and stop scan frequencies to see a slightly wider bandwidth, or capture something along one band edge. This frequency field allows a simple way to know if the traces stored in the database are compatible for comparison and estimation.
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
RBW Field
The Resolution Bandwidth setting for the channel.
VB
Public RBW As Single
C#
public float RBW
C++
public float 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
StopFreq Field
The sweep Stop Frequency in Hz.
VB
Public StopFreq As Double
C#
public double StopFreq
C++
public double StopFreq
SweepTimeOut Field
A value that sets the number of seconds Vision Acquire waits for a probe to respond before moving on.
VB
Public SweepTimeOut As Integer
C#
public int SweepTimeOut
C++
public int SweepTimeOut
Remarks
Sometime a probe will become unresponsive. We do not want to hold up monitoring all other channels and probes waiting for one to come back on line. How long Vision Acquire should wait is a function of the actual sweep rate, which can vary a lot depending on sweep parameters, and also network or connection latency and throughput.
TraceMode Field
Sets the trace mode: Normal, Averaging, Max Hold, Min Hold.
VB
Public TraceMode As Integer
C#
public int TraceMode
C++
public int 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 Single
C#
public float VBW
C++
public float VBW
Enumerations
ArchivePeriods Enumeration
ArchivePeriods enumeration is used to set how often Vision Acquire archives a database.
Value
 
ArchivePeriods Values and Definitions
Value
Definition
Hours3
Archive the database every 3 hours.
Hours6
Archive the database every 3 hours.
Hours12
Archive the database every 3 hours.
Days1
Archive the database every day.
Days2
Archive the database every 2 days.
Days4
Archive the database every 4 days.
Days7
Archive the database every 7 days.
Weeks2
Archive the database every 2 weeks.
Weeks4
Archive the database every 4 weeks.
Weeks8
Archive the database every 8 weeks.
Months3
Archive the database every 3 months.
Months6
Archive the database every 6 months.
Year1
Archive the database every year.
NotifyType Enumeration
NotifyType sets the notification type for sending reports.
Value
 
NotifyType Values and Definitions
Value
Definition
None
Do Not send status e-mails to the designated recipient.
Sweep
Send status e-mails to this recipient after every run through the database.
Daily
Send status e-mails to this recipient after every day.
Weekly
Send status e-mails to this recipient once each week.