AFSDK.psm1

# Check to ensure OSIsoft's AFSDK is loaded.
if (
    ([System.AppDomain]::CurrentDomain.GetAssemblies() | Where-Object {$_.GetName().Name -eq "OSIsoft.AFSDK"}).Count -ne 1
) {
    throw "OSIsoft.AFSDK assembly not found." # TODO: Make this a missing assembly reference.
}

function Get-AfAnalysesInputPiPoints {
    # Returns a list of PI Points that act as inputs for a list of Analyses.
    <#
    Function returns a list of PI Points that act as inputs for a list of analyses
    
    #>
    [CmdletBinding()]
    Param(
        [Parameter(position = 0, Mandatory = $true, ValueFromPipeline)]
        [OSIsoft.AF.Analysis.AFAnalysis[]]
        $AfAnalysesObjects
    )
    $InputAfAttributes = $AfAnalysesObjects.AnalysisRule.GetConfiguration().GetInputs()
    $PiPoints = $InputAfAttributes.PIPoint.Where({$_ -ne $null})
    $uniquePiPoints = $PiPoints | Select-Object -Unique
    # $uniquePiPoints = [linq.Enumerable]::Distinct($PiPoints) <-- Not sure which one is more efficient. Both Seem light-weight.
    return $uniquePiPoints
}

function Get-AfAnalysesOutputPiPoints {
    # Returns a list of PI Points that receive data from a list of Analyses.
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory, ValueFromPipeline)]
        [OSIsoft.AF.Analysis.AFAnalysis[]]
        $AfAnalyses
    )
    $InputAfAttributes = $AfAnalyses.AnalysisRule.GetConfiguration().GetOutputs()
    $PiPoints = $InputAfAttributes.PIPoint.Where({$_ -ne $null})
    $uniquePiPoints = $PiPoints | Select-Object -Unique
    # $uniquePiPoints = [linq.Enumerable]::Distinct($PiPoints) <-- Not sure which one is more efficient. Both Seem light-weight.
    return $uniquePiPoints
}

function Get-AllAfAnalyses {
    # Returns an IEnumerable of all AF Analyses from an AF Database or AF Server
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory, ParameterSetName="PiSystem")]
        [OSIsoft.AF.PISystem]
        $PiSystem,

        [Parameter(Mandatory, ParameterSetName="AfDatabase")]
        [OSIsoft.AF.AFDatabase]
        $AfDatabase
    )

    switch ($PSCmdlet.ParameterSetName) {
        PiSystem {
            $AfDatabases = $PiSystem.Databases
            Write-Debug "Finding AFAnalyses in $($AfDatabases.Count) AF Databases on $($PiSystem.Name)"
            $SearchResultsPerAfDatabase = [System.Collections.ArrayList]::new()
            foreach ($AfDatabase in $AfDatabases)
            {
                $AfDatabaseSearchResults = Get-AllAfAnalyses -AfDatabase $AfDatabase
                if ($AfDatabaseSearchResults.Count -gt 0)
                {
                    $SearchResultsPerAfDatabase.Add([OSIsoft.AF.Analysis.AFAnalysis[]]$AfDatabaseSearchResults) |Out-Null
                }
            }
            # Flatten list of lists.
            $SearchResults = $SearchResultsPerAfDatabase | ForEach-Object { $_ }
            return $SearchResults
        }
        AfDatabase {
            $Search = [OSIsoft.AF.Search.AFAnalysisSearch]::new($AfDatabase, "AfAnalysisSearch", "name:*")
            $Search.CacheTimeout = [TimeSpan]::FromMinutes(10)
            Write-Debug "$($Search.GetTotalCount()) AFAnalyses found."
            $SearchResults = $Search.FindObjects()
            return [OSIsoft.AF.Analysis.AFAnalysis[]]$SearchResults
        }
    }
}

function Get-OpenAFEventFrames {
    <#
    From an AF Database or from an AF Server (use parameter sets), retrieve an array of EventFrames that are open.
    Mandatory Parameter: AFServerName - Specifies what AF Server to search.
    Optional Paramaters:
        -inputRange specifies time range in PI acceptable time formats (ex: "14d") default is set to 2 weeks.
        -databaseName specifies a certain database within AFServerName parameter if you only want to search one database.
    #> 

    Param(
        [Parameter(Mandatory=$true, ParameterSetName='AfServer')]
        [OSIsoft.AF.PISystem] #turn into [osisoft.af.pisystems]
        $AfServer,
       
        [Parameter(mandatory=$true, ParameterSetName='AfDatabase')]
        [OSIsoft.AF.AFDatabase]
        $AfDatabase,

        [Parameter(Mandatory=$false)]
        [string]
        $LongerThan
    )
    switch ($PSCmdlet.ParameterSetName)
    {
        'AfServer' {
            $AfServerEfs = [System.Collections.Generic.List[OSIsoft.AF.EventFrame.AFEventFrame]]::new()
            foreach($AfDatabase in $AfServer.Databases)
            {
                $AfDatabaseEfs = Get-OpenAFEventFrames -afDatabase $AfDatabase -LongerThan $LongerThan
                for ($i=0; $i -lt $AfDatabaseEFs.Count; $i++)
                {
                    $AfServerEFs.Add($AFDatabaseEfs[$i]) | Out-Null
                }
            }
            return [OSIsoft.AF.EventFrame.AFEventFrame[]]$AfServerEfs
        }
        'AfDatabase' {
            
            $searchTokens = [System.Collections.Generic.List[OSIsoft.AF.Search.AFSearchToken]]::new()
            #Add search tokens to list
            if ($LongerThan)
            {
                $searchTokens.Add([OSIsoft.AF.Search.AFSearchToken]::new(
                    [OSIsoft.AF.Search.AFSearchFilter]::Start,
                    [OSIsoft.AF.Search.AFSearchOperator]::GreaterThan,
                    [OSIsoft.AF.Time.AFTime]::new("*-$LongerThan")
                )) | Out-Null
            }

            $searchTokens.Add([OSIsoft.AF.Search.AFSearchToken]::new(
                [OSIsoft.AF.Search.AFSearchFilter]::InProgress,
                [OSIsoft.AF.Search.AFSearchOperator]::Equal,
                $true
            )) | Out-Null

            [OSIsoft.AF.Search.AFEventFrameSearch]$AFEventFrameSearch = [OSIsoft.AF.Search.AFEventFrameSearch]::new($afDatabase, "EventFrameSearch", [System.Collections.Generic.List[OSIsoft.AF.Search.AFSearchToken]]$searchTokens)
            $count = $AFEventFrameSearch.GetTotalCount()
            Write-Host "$count EF's found in $afdatabase."

            $AFEventFrames = [Linq.Enumerable]::ToArray(
                $AFEventFrameSearch.FindObjects(0, $true, 500)
            )
            return [OSIsoft.AF.EventFrame.AFEventFrame[]]$AfEventFrames
        }
    }
}
function Stop-AfEventFrames {
    Param(
        [Parameter(Mandatory=$true)]
        [OSIsoft.AF.EventFrame.AFEventFrame[]]
        $AFEventFrames,

        [Parameter(Mandatory=$false)]
        [string]
        $LogFilePath
        # TODO: Find a way to validate the log file path to make sure it is a valid one.
        # Can incorporate own log function if available.
    )
   
    for ($i = 0; $i -lt $AFEventFrames.Count; $i++) {
        # $afeventframes[$i].CheckOut()
        [osisoft.af.eventframe.AFeventframe]$AFEventFrames[$i].undocheckout($true)
        [OSIsoft.AF.EventFrame.AFEventFrame]$Afeventframes[$i].setendTime("*")
        $afeventframes[$i].CheckIn() 
    }
}

function Get-PiVisionDisplayAfAttributes {}

function Get-PiPointProperties {} #get-pipointsummaries app027

function Convert-ObjectsToPsCustomObjects{
    <# 
    Generically converts Objects to PSCustom Objects to enable use with PowerShell functions like Export-Csv and Out-Gridview.
    Mandatory Parameter:
        -ObjectArray is the array of AFEventFrameObjects user wants to convert.
    Optional Parameters:
        -Properties is a user defined list of properties from the AFEventFrameObject that will be output. Default value is set to all.
    #>
    Param(
         [Parameter(ValueFromPipeline)]
         [Object[]]
         $ObjectArray,

         [Parameter(Mandatory=$False)]
         [String[]]
         $Properties
     )
    #Create empty list of PSCustomObjects
    $PSCustomObjects = [Collections.Generic.List[PSCustomObject]]::new()
    #Iterate through each Object in user-provided ObjectArray and populate fields with values.
    #Default fields are set to "All" if user does not provide a list of properties
     foreach ($object in $objectarray){
        #Creates an Ordered Dictionary for each object to preserve the order  
        $ObjDict = [Collections.Specialized.OrderedDictionary]::new()
        $defaultpropertyList = $object.PSObject.Properties.Name
        if($null -eq $Properties){
            foreach($property in $defaultpropertyList){
                $ObjDict.Add($property, $object.$property)
            }
            #Casts Ordered Dictionary into a PSCustomObject and adds it to a list of PSCustomObjects
            $PSCustomObjects.Add([PSCustomObject]$ObjDict)
        }
        else {
            #Same steps, but for when user provides list of properties as argument.
            foreach($property in $Properties){
                $ObjDict.Add($property, $object.$property)         
            }
            $PSCustomObjects.Add([PSCustomObject]$ObjDict)
        }
    }
     return $PSCustomObjects
}

function Remove-AfEventFrames {
    Param(
        [Parameter(Mandatory=$true)]
        [OSIsoft.AF.EventFrame.AFEventFrame[]]
        $AFEventFrames,

        [Parameter(Mandatory=$false)]
        [string]
        $LogFilePath
        # TODO: Find a way to validate the log file path to make sure it is a valid one.
        # Can incorporate own log function if available.
    )
   
    for ($i = 0; $i -lt $AFEventFrames.Count; $i++) {
        # $afeventframes[$i].CheckOut()
        [osisoft.af.eventframe.AFeventframe]$AFEventFrames[$i].undocheckout($true)
        [OSIsoft.AF.EventFrame.AFEventFrame]$Afeventframes[$i].Delete()
        $afeventframes[$i].CheckIn() 
    }
}