Execute a calibration as defined in a Calibration section of the configuration file and log the events in a log file. See also Calibrate.

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.

logFilename:

The full path and name of the file to store the log of events. This is an optional parameter and if omitted then the log file will have the same name as the calibration and be located in the same directory as the executable.

Return Value:        

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

Interface Signature:

bool LogCalibrate(string calName, string pnaName, string logFilename = null);


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 and log the events
       /// </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.LogCalibrate("Cal_First_Plane", "PNA-X", "C:\\Temp\\MyLogFile.Log");
       }
   }
}