Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA Enterprise SCADA BLT API Reference

Register and define parameters

This scenario guides you through the steps required to register parameters, define the input and output parameters, and specify whether these input and output parameters are mandatory.

To identify the code associated with each step, see the code comments in the Example code section.

To register and define parameters

  1. Open the Program.cs file from the created project.
  2. Navigate to the TestBLTProcessor class.
  3. Instantiate the Parameters attribute of the BLTProcessor class, registering the parameters at the constructor of the TestBLTProcessor class.
  4. For each parameter, define the following:
    • The type of the parameter.
    • Whether the parameter is an input or an ouput.
    • Whether the parameter is optional or mandatory.

Example code

// Instantiate the Parameters attribute of the BLTProcessor class, registering the parameters at the constructor of the TestBLTProcessor class.
public TestBLTProcessor()
{
    // Define the parameters.
    Parameters = new BLTParameterList
    {
        // In this example, the first parameter represents the table name. It is a non-optional, input string parameter.
        new BLTParameter(szName: "table", paramType: typeof(string), bOptional: false, bIsOutput: false),
        // In this example, the second parameter represents the point name. It is a non-optional, input string parameter.
        new BLTParameter(szName: "point", paramType: typeof(string), bOptional: false, bIsOutput: false),
        // In this example, the third parameter represents the number of alarms. It is a non-optional, output integer parameter.
        new BLTParameter(szName: "numberOfAlarms", paramType: typeof(Int32), bOptional: false, bIsOutput: true),
        // In this example, the fourth parameter represents the number of events. It is a optional, output integer parameter.
        new BLTParameter(szName: "numberOfEvents", paramType: typeof(Int32), bOptional: true, bIsOutput: true)                   
    };
}
TitleResults for “How to create a CRG?”Also Available in