AFCase.IsActiveTransfer Method

public AFCaseAFActiveTransferStatus IsActiveTransfer(
	AFTransfer transfer
)

Public Function IsActiveTransfer ( 
	transfer As AFTransfer
) As AFCaseAFActiveTransferStatus

Dim instance As AFCase
Dim transfer As AFTransfer
Dim returnValue As AFCaseAFActiveTransferStatus

returnValue = instance.IsActiveTransfer(transfer)

public:
AFCaseAFActiveTransferStatus IsActiveTransfer(
	AFTransfer^ transfer
)

member IsActiveTransfer : 
        transfer : AFTransfer -> AFCaseAFActiveTransferStatus 

Parameters

transfer

Type: OSIsoft.AF.EventFrameAFTransfer
The AFTransfer to check if it is active within the case.

Return Value

This method is to be used with an AFAnalysis with an AFModel as its Target. The AFAnalysisRule.CollectTransfers method uses this method to determine which transfers are active for the case and should be included in the Elements collection.

This method determines that an AFTransfer is active if the case's Elements collection of active elements contains the transfer's Source element and/or Destination element. The transfer's StartTime and EndTime must overlap the case's StartTime and EndTime.

AFSDK

Reference