Execute a calibration as defined in a Calibration section of the configuration file.

Parameters:

calName:

The name of the calibration configuration section that defines this calibration.

pnaName:

The name of the PNA being used to make the measurements.

Return Value:

True on Success.    If the function fails use GetErrorMessage to get the specific errors associated with the failure.

Interface Signature:

bool Calibrate(string calName, string pnaName);


When the calibration is successfully completed the PNA will have a Cal Set as defined in the calibration section and this Cal Set will be active.

An example of how this function is used  is shown below.

using System;

namespace Example
{
   /// <summary>
   /// An simple example of how to utilize the API and get a reference to it
   /// </summary>
   public class ExampleClass
   {
       /// <summary>
       /// Run a calibration
       /// </summary>
       public static bool Calibrate(string calName, string pnaName)
       {
           // Get a reference to the API interface
           AteSystems.InCal.IApi api = AteSystems.InCal.API.Initialize(@"C:\Temp\MyConfig.ini", catchExceptions:true);
           // Call the API function
           return api.Calibrate(calName, pnaName);
       }
   }
}