AFCase.Run Method
- Last UpdatedSep 18, 2024
- PI System
- AF SDK 2024
- Developer
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156
Syntax
public bool Run()
Public Function Run As Boolean Dim instance As AFCase Dim returnValue As Boolean returnValue = instance.Run()
public: bool Run()
member Run : unit -> bool
Return Value
Type: BooleanReturns true if the operation was successful. Any messages generated during the case run process will be output using AFTrace.
Remarks
The AFAnalysisRule used by this method is defined by the AFAnalysis that owns this case. This method is usually called after collecting the transfers if this is a AFCase used for model analysis (using the CollectTransfers() method) and collecting the input values (using the CollectInputs() method) and any necessary adjustments have been made to the attribute values (using the AFAdjustments.Add method). The RunTime property is updated whenever this method is called and returns without errors.
The Before event is raised before this operation is started to allow clients an opportunity to perform any required validation or processing before starting the operation. The operation can also be canceled by setting the Cancel property of the AFCaseCancelEventArgs parameter to the event. The Executing event is raised during the execution of the operation to allow clients an opportunity to cancel and not wait for the operation to complete. The After event is raised after the operation is completed to allow clients an opportunity to perform any post-processing.
 Security Note |
|---|
| You must have Execute security rights to run a case. |