AFSearch(T) Class

Public MustInherit Class AFSearch(Of T As AFObject)
	Inherits AFSearch
	Implements IAFSearch(Of T)

Dim instance As AFSearch(Of T)

generic<typename T>
where T : AFObject
public ref class AFSearch abstract : public AFSearch, 
	IAFSearch<T>

[<AbstractClassAttribute>]
type AFSearch<'T when 'T : AFObject> =  
    class
        inherit AFSearch
        interface IAFSearch<'T>
    end

' Get the Database
Dim myPISystems As New PISystems()
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
If myPISystem Is Nothing Then
    Throw New InvalidOperationException("Default PISystem was not found.")
End If
Dim myDB As AFDatabase = myPISystem.Databases(dbName)
If myDB Is Nothing Then
    Throw New InvalidOperationException("Database was not found.")
End If

' Create a search to find all the elements in a specific area
' of a plant (e.g. 'WestPlant\Area32') and have either a 'Valve' or 'Boiler' category.
Dim count As Integer
Using search As New AFElementSearch(myDB, "FindValves", "Root:'WestPlant\Area32' (Category:'Valve' OR Name:Valve*)")

    search.CacheTimeout = TimeSpan.FromMinutes(10)

    ' When the elements are returned from a find operation, they are only
    ' partially loaded into memory, typically enough to display their 
    ' inherent properties, such as Name, Description, Template, Type, etc.  
    ' When a piece of information is accessed in the element that requires more 
    ' information, an RPC to the server is made to fully load the element.  
    ' By having the search do a full load, all information is loaded in bulk and
    ' we can reduce the number of RPCs made to retrieve this information.
    count = search.GetTotalCount()
    Console.WriteLine("Found {0} Elements.", count)
    For Each item As AFElement In search.FindObjects(fullLoad:=True)

        ' Now we can use the elements without having to make any additional RPCs
        ' In the example below, accessing the Attributes collection would have 
        ' caused an additional RPC per element found.
        ' Now we can use the elements without having to make any additional RPCs
        ' In the example below, accessing the Attributes collection would have 
        ' caused an additional RPC per element found.
        Console.WriteLine("  Element {0} has {1} Attributes", item.Name, item.Attributes.Count)
    Next
End Using

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

' Get the Database
Dim myPISystems As New PISystems()
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
If myPISystem Is Nothing Then
    Throw New InvalidOperationException("Default PISystem was not found.")
End If
Dim myDB As AFDatabase = myPISystem.Databases(dbName)
If myDB Is Nothing Then
    Throw New InvalidOperationException("Database was not found.")
End If

' Use attribute value query to find a list of tanks that are 
' In Service (tanks which are out-of-service have their 
' Status attribute set to "OS").
Dim totalCount As Integer = 0
Using search As New AFElementSearch(myDB, "FindTanks", "Template:'TankAdvanced' |Status:<>'OS'")

    search.CacheTimeout = TimeSpan.FromMinutes(10)

    ' Because we are only going to use a few of the attributes for each
    ' of the elements found, we can reduce the load time and memory space
    ' by just loading the attributes we need.  Note that if we inadvertently
    ' use attributes other than these, we will incur a load penalty.
    Dim tankTemplate As AFElementTemplate = myDB.ElementTemplates("Tank")
    Dim myAttributes As New AFNamedCollectionList(Of AFAttributeTemplate)()
    myAttributes.Add(tankTemplate.AttributeTemplates("Volume"))
    myAttributes.Add(tankTemplate.AttributeTemplates("Level"))
    myAttributes.Add(tankTemplate.AttributeTemplates("Level|HighLimit"))
    myAttributes.Add(tankTemplate.AttributeTemplates("Level|LowLimit"))

    ' Get today's date and UOMs to be used for converting values.
    Dim today As New AFTime("T", CultureInfo.CurrentCulture)
    Dim bbl As UOM = myDB.PISystem.UOMDatabase.UOMs("bbl")
    Dim meter As UOM = myDB.PISystem.UOMDatabase.UOMs("m")

    Const pageSize As Integer = 1000
    Dim startIndex As Integer = 0
    Dim myElementIds As IList(Of Guid) = New List(Of Guid)(pageSize)
    Do
        ' Find the elements and load the attributes we will be using.
        Dim results As IEnumerable(Of Guid) = search.FindObjectIds(startIndex, pageSize:=pageSize)
        myElementIds.Clear()
        Dim c As Integer = 0
        For Each id As Guid In results
            totalCount += 1
            myElementIds.Add(id)
            c += 1
            If c >= pageSize Then
                Exit For
            End If
        Next

        If myElementIds.Count = 0 Then
            Exit Do
        End If
        Dim elements As AFNamedCollectionList(Of AFElement) =
            AFElement.LoadAttributes(myPISystem, myElementIds, myAttributes)

        ' Once the elements are loaded, we can process them.
        For Each element As AFElement In elements
            Try
                Dim attributes As New AFAttributeList()
                attributes.Add(element.Attributes("Volume"))
                attributes.Add(element.Attributes("Level"))
                attributes.Add(element.Attributes("Level|HighLimit"))
                attributes.Add(element.Attributes("Level|LowLimit"))
                Dim values As AFValues = attributes.GetValue(today)

                If values(0).IsGood AndAlso values(1).IsGood AndAlso values(2).IsGood AndAlso values(3).IsGood Then
                    Dim volume As Double = CDbl(values(0).Convert(bbl).Value)
                    Dim level As Double = CDbl(values(1).Convert(meter).Value)
                    Dim high As Double = CDbl(values(2).Convert(meter).Value)
                    Dim low As Double = CDbl(values(3).Convert(meter).Value)

                    Console.WriteLine("Tank Inventory for '{0}' is {1} bbl.  %Full={2}", element.Name, volume, 100 * (high - low) / level)
                Else
                    Console.WriteLine("Bad data in Tank '{0}'", element.Name)
                End If
            Catch generatedExceptionName As FormatException
                Console.WriteLine("Error in Tank '{0}'", element.Name)
            End Try
        Next

        ' Advance to next page.
        startIndex += myElementIds.Count
    Loop While myElementIds.Count > 0 AndAlso myElementIds.Count >= pageSize
End Using

Console.WriteLine("Processed {0} Elements.", totalCount)

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

 1'*************************************************************************
 2''' <summary>
 3''' This class defines the object fields returned from the 
 4''' FindObjectFields method.
 5''' </summary>
 6Public Class EventFrameFields
 7    ' Field mapped using default name.
 8    Public ID As Guid
 9    ' Property mapped using default name.
10    Public Property Name() As String
11        Get
12            Return m_Name
13        End Get
14        Set
15            m_Name = Value
16        End Set
17    End Property
18    Private m_Name As String
19    ' Field mapped using 'ObjectField' attribute.
20    <AFSearch.ObjectField("Duration")>
21    Public EFDuration As AFTimeSpan
22    ' Property mapped using 'ObjectField' attribute.
23    <AFSearch.ObjectField("StartTime")>
24    Public Property EFStart() As AFTime
25        Get
26            Return m_EFStart
27        End Get
28        Set
29            m_EFStart = Value
30        End Set
31    End Property
32    Private m_EFStart As AFTime
33    ' Attribute value mapped to property using 'ObjectField' attribute.
34    <AFSearch.ObjectField("|Level")>
35    Public Property Level() As AFValue
36        Get
37            Return m_Level
38        End Get
39        Set
40            m_Level = Value
41        End Set
42    End Property
43    Private m_Level As AFValue
44End Class
45
46'*************************************************************************

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

' Get the Database
Dim myPISystems As New PISystems()
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
If myPISystem Is Nothing Then
    Throw New InvalidOperationException("Default PISystem was not found.")
End If
Dim myDB As AFDatabase = myPISystem.Databases(dbName)
If myDB Is Nothing Then
    Throw New InvalidOperationException("Database was not found.")
End If

' Create a search to find all the event frames created from the 'Event'
' template and its 'Level' attribute value is less than 90.
Dim count As Integer
Using search As New AFEventFrameSearch(myDB, "FindEventFields", "Template:'Event' |Level:<90.0")

    search.CacheTimeout = TimeSpan.FromMinutes(10)

    ' Do the search

    ' Return specified fields as object list.
    count = 0
    Console.WriteLine("Find Object Fields:")
    For Each row As IList(Of Object) In search.FindObjectFields("ID Name StartTime EndTime |Level")
        count += 1
        For Each item As Object In row
            Console.Write("{0}, ", item)
        Next
        Console.WriteLine()
    Next
    Console.WriteLine("Found {0} EventFrames.", count)

    ' Return specified fields as an anonymous type.
    count = 0
    Dim foundItems2 = search.FindObjectFields("ID Name StartTime EndTime |Level",
                        Function(i) New With {.ID = i(0), .Name = i(1), .Start = i(2), .[End] = i(3), .Value = i(4)})
    Console.WriteLine("Find Object Fields using Anonymous Type:")
    For Each row In foundItems2
        count += 1
        Console.WriteLine("ID={0}, N='{1}', ST={2}, ET={3}, V={4}", row.ID, row.Name, row.Start, row.[End], row.Value)
    Next
    Console.WriteLine("Found {0} EventFrames.", count)

    ' Return event frame name as list of strings.
    count = 0
    Dim foundItems3 = search.FindObjectFields("Name", Function(i) i(0).ToString())
    Console.WriteLine("Find Object Names as list of strings:")
    For Each row As String In foundItems3
        count += 1
        Console.WriteLine(row)
    Next
    Console.WriteLine("Found {0} EventFrames.", count)

    ' Return event frame security tokens as list and check security for current user.
    count = 0
    Dim foundItems4 = search.FindObjectFields("SecurityToken", Function(i) CType(i(0), AFSecurityRightsToken))
    Console.WriteLine("Find Object SecurityTokens and Check Security:")
    For Each tokenList In foundItems4.ChunkedBy(500)
        ' Check Security using Windows Identity.
        Dim rights = AFSecurity.CheckSecurity(myPISystem, WindowsIdentity.GetCurrent, tokenList)
        For Each rightsItem In rights
            Console.WriteLine($"  Security Rights for '{myPISystem.CurrentUserName}': {rightsItem.Key} = {rightsItem.Value}")
        Next

        ' Check Security using Identities.
        rights = AFSecurity.CheckSecurity(myPISystem, myPISystem.CurrentUserIdentities, tokenList, myPISystem.CurrentUserName)
        For Each rightsItem In rights
            Console.WriteLine($"  Security Rights for '{myPISystem.CurrentUserIdentityString}': {rightsItem.Key} = {rightsItem.Value}")
        Next
        count = (count + tokenList.Count)
    Next
    Console.WriteLine("Found {0} EventFrames.", count)

    ' Return specified fields using dynamic type conversion.
    count = 0
    Dim foundDynItems = search.FindObjectFields(Of EventFrameFields)()
    Console.WriteLine("Find Object Fields using Dynamic Type Conversion:")
    For Each row In foundDynItems
        count += 1
        Console.WriteLine("ID={0}, N='{1}', ST={2}, D={3}, V={4}", row.ID, row.Name, row.EFStart, row.EFDuration, row.Level)
    Next
    Console.WriteLine("Found {0} EventFrames.", count)

End Using

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

 1' Get the Database
 2Dim myPISystems As New PISystems()
 3Dim myPISystem As PISystem = myPISystems.DefaultPISystem
 4If myPISystem Is Nothing Then
 5    Throw New InvalidOperationException("Default PISystem was not found.")
 6End If
 7Dim myDB As AFDatabase = myPISystem.Databases(dbName)
 8If myDB Is Nothing Then
 9    Throw New InvalidOperationException("Database was not found.")
10End If
11
12' Create a search to find all the event frames created from the 'Event'
13' template, with a start time greater than or equal to three days ago,
14' and its 'Level' attribute value is greater than or equal 45.
15' Note: Time Strings must be in a format supported by AFTime.Parse which
16'       will use current culture And then fall back to invariant culture.
17Dim count As Integer
18Using search As New AFEventFrameSearch(myDB, "FindEvents", "Template:'Event' Start:>='*-3d' |Level:>=45.0")
19
20    search.CacheTimeout = TimeSpan.FromMinutes(10)
21
22    ' When the event frames are returned from a find operation, they are only
23    ' partially loaded into memory, typically enough to display their 
24    ' inherent properties, such as Name, Description, Template, etc.  
25    ' When a piece of information is accessed in the event frame that requires more 
26    ' information, an RPC to the server is made to fully load the event frame.  
27    ' By having the search do a full load, all information is loaded in bulk and
28    ' we can reduce the number of RPCs made to retrieve this information.
29    count = search.GetTotalCount()
30    Console.WriteLine("Found {0} EventFrames.", count)
31    For Each item As AFEventFrame In search.FindObjects(fullLoad:=True)
32        ' Now we can use the event frames without having to make any additional RPCs
33        ' In the example below, accessing the Attributes collection would have 
34        ' caused an additional RPC per element found.
35        ' Now we can use the event frames without having to make any additional RPCs
36        ' In the example below, accessing the Attributes collection would have 
37        ' caused an additional RPC per event frame found.
38        Console.WriteLine("  EventFrame {0} has {1} Attributes", item.Name, item.Attributes.Count)
39    Next
40End Using

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.