Vision™ MX280001A Spectrum Monitoring Application Programming Interface : Vision API Reference : MaskEditor Class
 
MaskEditor Class
Properties
MaskEditor.MaskName Property
Use this property to get/set the name of the current mask.
VB
Public Property MaskName() As String
C#
public string MaskName {get; set;}
C++
public string MaskName {get; set;}
Property Value
Type: String
Remarks
Returns the name of the current mask in the Mask Editor.
Methods
MaskEditor.GetDatabasePath Method
VB
Public Function GetDatabasePath() As String
C#
public String GetDatabasePath()
C++
public String GetDatabasePath()
Remarks
Returns the current database path in the local file system.
MaskEditor.GetMaskList Method
VB
Public Function GetMaskList() As List(OfString)
C#
public List<String> GetMaskList()
C++
public List<String> GetMaskList()
Remarks
Returns a list of all masks in the active database. Each entry in the list contains two fields, delimited by a semi-colon. The first field indicates if the mask is segmented or continuous (Trace). The second field is the mask name.
MaskEditor.RemoveAMaskFromDB Method
VB
Public Sub RemoveAMaskFromDB(ByVal Maskname As String_)
C#
public System.Void RemoveAMaskFromDB(String Maskname)
C++
public System.Void RemoveAMaskFromDB(String Maskname)
Parameters
Maskname: The name of the mask to be removed.
Remarks
Removes the mask from the database. The Maskname parameter is not case sensitive. If not found, nothing is done.
MaskEditor.SetDatabasePath Method
VB
Public Function SetDatabasePath(ByVal Path As String_) As Boolean
C#
public bool SetDatabasePath(String Path)
C++
public bool SetDatabasePath(String Path)
Parameters
Path: The full path in the local file system to the database you want to access with the MaskEditor API.
Remarks
Sets the path to the active database. This is the path only, and should not include a database name.
MaskEditor.addSegmentedMaskToDB Method
VB
Public Function addSegmentedMasktoDB(ByVal MaskName As String,ByVal MaskDescription As String_) As Boolean
C#
public bool addSegmentedMasktoDB(String MaskName,String MaskDescription)
C++
public bool addSegmentedMasktoDB(String MaskName,String MaskDescription)
Parameters
MaskName: The name of the mask to add. This name will identify the mask in the database and will be used to assign a particular mask to channels for Pass/Fail qualification.
MaskDescription: The full description of the mask. See Remarks below for the format.
Remarks
Maskname should be unique. Giving two masks in a database the same name will cause a conflict and you will not know which is being used.
MaskDescription is a string value the contains the mask segment parameters. The format is:
StartFreq_1, StopFreq_1, Level_1, UpperLower_1; StartFreq_2, StopFreq_2, Level_2, UpperLower_2; ... ;StartFreq_n, StopFreq_n, Level_n, UpperLower_n
Where UpperLower: 0 for Upper limit; 1 for lower limit
MaskEditor.addTraceMaskToDB Method
VB
Public Function addTraceMasktoDB(ByVal MaskName As String,ByVal Freq1 As Single,ByVal Freq2 As Single,_ByVal TraceData As String,ByVal UpperLimit As Boolean)As Boolean
C#
public bool addTraceMasktoDB(String MaskName,float Freq1,float Freq2, String TraceData, bool UpperLimit)
C++
public bool addTraceMasktoDB(String MaskName,float Freq1,float Freq2, String TraceData, bool UpperLimit)
Parameters
MaskName: The name of the mask to add. This name will identify the mask in the database and will be used to assign a particular mask to channels for Pass/Fail qualification.
Freq1: The start frequency for the mask in Hz.
Freq2: The stop frequency of the mask in Hz.
TraceData: The mask trace data. A comma string containing power values in dBm used to qualify traces.
UpperLimit: Boolean value indicates if the mask is to be considered an upper limit (True) or a lower limit (False).
Remarks
Maskname should be unique. Giving two masks in a database the same name will cause a conflict and you will not know which is being used.
TraceData is a comma delimited string of power values in dBm. It is expected to have the same number of points as the trace DisplayPoints it will be used to test.