FlowNetworkStopStations Business Logic Tier (BLT)
- Last UpdatedApr 24, 2025
- 2 minute read
You can use the FlowNetworkStopStations Business Logic Tier (BLT) to execute the Shutdown Sequence action for all pumps in the specified stations. For more information, refer to the AVEVA Pipeline Operations for Liquids Administrator documentation.
The following table details the parameters of the FlowNetworkStopStations BLT.
|
Name |
Type |
Optional |
Output |
Description |
|---|---|---|---|---|
|
FlowNetworkName |
string |
False |
False |
This input parameter specifies the name of the Flow Network containing the stations to shut down. |
|
Stations |
string |
False |
False |
This parameter specifies the list of stations to shutdown (separated by space or comma). |
|
Result |
int |
False |
True |
This parameter indicates the execution result. It will return a 0 for success and a non-zero value if an error occurs. |
|
Message |
string |
False |
True |
This output parameter will provide a result message after execution. |
FlowNetworkStopStations BLT Programming Example
The following is an example of how you can program using the FlowNetworkStopStations Business Logic Tier (BLT):
string flowNetworkName = "AT_LongLine";
string stationsToStop = "AT_LL_PumpStation1";
BLTParameterValueAccessor result;
BLTParameterValueAccessor message;
var bltClientFactory = new BLTClientFactory();
using (var client = bltClientFactory.Create("FlowNetworkStopStations"))
{
client.AddParameter(flowNetworkName);
client.AddParameter(stationsToStop);
client.AddParameter(out result); //Result is an out param
client.AddParameter(out message); // Message is an out param
client.Execute();
if (Int32.TryParse(result.Value.ToString(), out int r) && r != 0)
{
Console.WriteLine("FlowNetworkStopStations failed, error:" +
message.Value.ToString());
}
}
FlowNetworkStopStations Assembly Programming Example
You can reference the assembly bobjFlowNetworkStopStations.dll inside an application to invoke the Business Logic Tier (BLT) functionality directly.
The following is an example of how you can program using the FlowNetworkStopStations assembly inside an application.
Note: This application must be running on a RealTime server with AVEVA Pipeline Operations for Liquids installed.
string flowNetworkArgumentName = "model_name_in_database";
string stationsShutdownList = "station1 station2 station3";
var stationStopObject = new bobjFlowNetworkStopStations.bobjFlowNetworkStopStations();
try
{
stationStopObject.Execute(flowNetworkArgumentName, stationsShutdownList);
}
catch(bobjFlowNetworkStopStations.Exceptions.FlowNetworkStopStationsProcessException ex)
{
Console.WriteLine("Error code " + ex.Result + " " + ex.Message);
}