AF SDK Reference

AFCase Constructor (AFAnalysis, AFTimeRuleEvent, Boolean)

Save PDF

TABLE OF CONTENTS

AFCase Constructor (AFAnalysis, AFTimeRuleEvent, Boolean)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Initializes a new temporary instance of an AFCase with its start and end times defined by an AFTimeRuleEvent.

Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public AFCase(
	AFAnalysis analysis,
	AFTimeRuleEvent timeRuleEvent,
	bool isTemporary
)

Public Sub New ( 
	analysis As AFAnalysis,
	timeRuleEvent As AFTimeRuleEvent,
	isTemporary As Boolean
)

Dim analysis As AFAnalysis
Dim timeRuleEvent As AFTimeRuleEvent
Dim isTemporary As Boolean

Dim instance As New AFCase(analysis, 
	timeRuleEvent, isTemporary)

public:
AFCase(
	AFAnalysis^ analysis, 
	AFTimeRuleEvent^ timeRuleEvent, 
	bool isTemporary
)

new : 
        analysis : AFAnalysis * 
        timeRuleEvent : AFTimeRuleEvent * 
        isTemporary : bool -> AFCase

Parameters

analysis: Type: OSIsoft.AF.AnalysisAFAnalysis
The new AFCase is associated with the specified AFAnalysis.
timeRuleEvent: Type: OSIsoft.AF.TimeAFTimeRuleEvent
The AFTimeRuleEvent used to specify the case's StartTime and EndTime.
isTemporary: Type: SystemBoolean
If , then a temporary AFCase is created. If , then a normal AFCase is created.

Remarks

The new temporary AFCase can be modified just like any other case, but the case cannot be saved. The case's result values are allowed to be published. A temporary case cannot be used to create another temporary case (using the CreateTemporary method) and it will not be returned by any of the FindCases Overload methods.

The case's StartTime and EndTime are initialized by the specified timeRuleEvent.

AF SDK Reference