AF SDK Reference

AFAnalysisRule.CollectTransfers Method

Save PDF

TABLE OF CONTENTS

AFAnalysisRule.CollectTransfers Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

This method collects the transfers that are active for the current case.

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

Syntax

public virtual bool CollectTransfers()

Public Overridable Function CollectTransfers As Boolean

Dim instance As AFAnalysisRule
Dim returnValue As Boolean

returnValue = instance.CollectTransfers()

public:
virtual bool CollectTransfers()

abstract CollectTransfers : unit -> bool 
override CollectTransfers : unit -> bool

Return Value

Type: Boolean
Returns if the operation was successful. Any messages generated during the collection process will be output using AFTrace.

Remarks

The default implementation uses the IsActiveTransfer(AFTransfer) method to determine which transfers are active for the AFCase. The analysis rule is able to override this method and implement a different criteria for determining active transfers. When overriding this method, use the AddElement protected method to add transfers to the case's Elements collection.

AF SDK Reference