AFAdjustments Class

Public NotInheritable Class AFAdjustments
	Inherits AFCollection(Of AFAdjustment)

Dim instance As AFAdjustments

public ref class AFAdjustments sealed : public AFCollection<AFAdjustment^>

[<SealedAttribute>]
type AFAdjustments =  
    class
        inherit AFCollection<AFAdjustment>
    end

' This example shows how to create an adjustment to an attribute value made during a case run.
' Note: This example assumes that there is a database called "Chocolate Milk Tutorial"
' with a Model named "ChocolateMilkModel", with a Model Analysis named "Volume Balance"
' The model also contains a "MilkTank1" child Element with a "Volume" Attribute

' Get the Database
Dim myPISystems As New PISystems
Dim myDB As AFDatabase = myPISystems.DefaultPISystem.Databases("Chocolate Milk Tutorial")

' Get the Model Analysis
Dim myAnalysis As AFAnalysis = AFAnalysis.FindAnalyses(myDB, "ChocolateMilkModel::Volume Balance",
    AFSearchField.Name, AFSortField.Name, AFSortOrder.Descending, 1)(0)

' Create a Case and Collect Inputs
Dim myCase As AFCase = myAnalysis.AddCase
myCase.CollectInputs()

' Create an Adjustment
Dim myResult As AFResult = myCase.Results(myDB.Elements("MilkTank1").Attributes("Volume"))
Dim CurAdjustment As AFAdjustment = myResult.Adjustments.Add("This is the creator.",
    "This is a comment.", "2 US gal", Nothing)
myDB.CheckIn()

' Display each Adjustment before clear method
Console.WriteLine("Adjustment Count = {0}", myResult.Adjustments.Count)
For Each CurAdjustment In myResult.Adjustments
    Console.WriteLine("Before Clear Method:")
    Dim ownerElement As AFElement = CType(CurAdjustment.Attribute.Element, AFElement)
    If (ownerElement <> Nothing) Then
        Console.WriteLine("  Element of Adjustment = {0}", ownerElement.Name)
    End If
    Console.WriteLine("  Attribute of Element Adjusted = {0}", CurAdjustment.Attribute.Name)
    Console.WriteLine("  Adjusted Value = {0}", CurAdjustment.AdjustedValue)
    Console.WriteLine("  Previous Value = {0}", CurAdjustment.PreviousValue)
Next CurAdjustment

' Call the clear method on the collection to clear the non-committed Adjustment values
myResult.Adjustments.Clear("This is the creator.", "This is the comment.")

' Display each Adjustment after clear method
Console.WriteLine("Adjustment Count = {0}", myResult.Adjustments.Count)
For Each CurAdjustment In myResult.Adjustments
    Console.WriteLine("After Clear Method:")
    Console.WriteLine("  Element of Adjustment = {0}", CurAdjustment.Attribute.Element.Name)
    Console.WriteLine("  Attribute of Element Adjusted = {0}", CurAdjustment.Attribute.Name)
    If CurAdjustment.AdjustedValue Is Nothing Then
        Console.WriteLine("  Adjusted Value = <null>")
    Else
        Console.WriteLine("  Adjusted Value = {0}", CurAdjustment.AdjustedValue)
    End If
    If CurAdjustment.PreviousValue Is Nothing Then
        Console.WriteLine("  Previous Value = <null>")
    Else
        Console.WriteLine("  Previous Value = {0}", CurAdjustment.PreviousValue)
    End If
Next CurAdjustment

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.