AFTransferSearch Constructor (AFDatabase, String, AFSearchMode, AFTime, AFTime, IList(AFSearchTokenBase))

Save PDF

Feedback

HomeAF SDK Reference...NamespacesOSIsoft.AF.SearchAFTransferSearch ClassAFTransferSearch Constructor AFTransferSearch Constructor (AFDatabase, String, AFSearchMode, AFTime, AFTime, IList(AFSearchTokenBase))

TABLE OF CONTENTS

AFTransferSearch Constructor (AFDatabase, String, AFSearchMode, AFTime, AFTime, IList(AFSearchTokenBase))

Save PDF

Feedback

Last UpdatedSep 18, 2024

Creates an instance of an AFTransferSearch to search for AFTransfer objects using the specified AFSearchMode, times and optional search query string.

Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156

Syntax

public AFTransferSearch(
	AFDatabase database,
	string name,
	AFSearchMode searchMode,
	AFTime startTime,
	AFTime endTime,
	IList<AFSearchTokenBase> tokens
)

Public Sub New ( 
	database As AFDatabase,
	name As String,
	searchMode As AFSearchMode,
	startTime As AFTime,
	endTime As AFTime,
	tokens As IList(Of AFSearchTokenBase)
)

Dim database As AFDatabase
Dim name As String
Dim searchMode As AFSearchMode
Dim startTime As AFTime
Dim endTime As AFTime
Dim tokens As IList(Of AFSearchTokenBase)

Dim instance As New AFTransferSearch(database, 
	name, searchMode, startTime, endTime, 
	tokens)

public:
AFTransferSearch(
	AFDatabase^ database, 
	String^ name, 
	AFSearchMode searchMode, 
	AFTime startTime, 
	AFTime endTime, 
	IList<AFSearchTokenBase^>^ tokens
)

new : 
        database : AFDatabase * 
        name : string * 
        searchMode : AFSearchMode * 
        startTime : AFTime * 
        endTime : AFTime * 
        tokens : IList<AFSearchTokenBase> -> AFTransferSearch

Parameters

database: Type: OSIsoft.AF.AFDatabase
The AFDatabase to be searched by the query. This parameter will initialize the Database property.
name: Type: System.String
The SearchName associated with the created search object. This is only informational and does not affect the searches.
searchMode: Type: OSIsoft.AF.Asset.AFSearchMode
The AFEventFrameSearchMode to be converted into a search query which indicates the direction in time from the StartTime or EndTime to proceed when returning transfers.
startTime: Type: OSIsoft.AF.Time.AFTime
The starting time to be used in the generated search query. The startTime must be less than or equal to the endTime. The searchMode parameter will control whether the comparison will be performed against the transfer's StartTime or EndTime.
endTime: Type: OSIsoft.AF.Time.AFTime
The ending time to be used in the generated search query. The endTime must be greater than or equal to the startTime. The searchMode parameter will control whether the comparison will be performed against the transfer's StartTime or EndTime.
tokens: Type: System.Collections.Generic.IList<AFSearchTokenBase>
The list of tokens to initialize the TokenCollection property for the new object and will be used when calling search method. A query string can be converted to a list of tokens by calling the ParseQueryString(String) method.

Remarks

This constructor will create a search query based upon the specified searchMode and times. The times in the query string will have the correct operators specified for the Start and/or End filters. The tokens will be used to add additional search filters to the search query. These parameters will be used to create tokens and initialize the TokenCollection property.

Version Information

AFSDK

Supported in: 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5

AF SDK Reference

Filters

Product Family