AFAnalysisTemplate Class

<SerializableAttribute>
Public NotInheritable Class AFAnalysisTemplate
	Inherits AFObject
	Implements IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable(Of AFAnalysisTemplate)

Dim instance As AFAnalysisTemplate

[SerializableAttribute]
public ref class AFAnalysisTemplate sealed : public AFObject, 
	IAFTransactable, IAFChangedEvent, IAFSecurable, IComparable<AFAnalysisTemplate^>

[<SealedAttribute>]
[<SerializableAttribute>]
type AFAnalysisTemplate =  
    class
        inherit AFObject
        interface IAFTransactable
        interface IAFChangedEvent
        interface IAFSecurable
        interface IComparable<AFAnalysisTemplate>
    end

' This example demonstrates how to create an analysis template, configure its
' analysis rule And time rule, And create an analysis from the template.

' Get the Database
Dim myPISystems As New PISystems
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
Dim myDB As AFDatabase = myPISystem.Databases.DefaultDatabase

' Create an Element Template with Attributes
Dim myElementTemplate As AFElementTemplate = myDB.ElementTemplates.Add("MyElementTemplate")
Dim myAttributeTemplate As AFAttributeTemplate = myElementTemplate.AttributeTemplates.Add("MyAttribute")
myAttributeTemplate.DataReferencePlugIn = AFDataReference.GetPIPointDataReference(myPISystem)
myAttributeTemplate.DataReference.ConfigString = "\\%Server%\sinusoid"

' Create an Analysis Template and set its Target to the Element Template
Dim myAnalysisTemplate As AFAnalysisTemplate = myDB.AnalysisTemplates.Add("MyAnalysisTemplate")
myAnalysisTemplate.Description = "This is an analysis example"
myAnalysisTemplate.Target = myElementTemplate

' Set the Analysis Rule and Time Rule
myAnalysisTemplate.AnalysisRulePlugIn = myPISystem.AnalysisRulePlugIns("Imbalance")
myAnalysisTemplate.TimeRulePlugIn = myPISystem.TimeRulePlugIns("Periodic")
myAnalysisTemplate.AnalysisRule.ConfigString = "Balance=Volume;Imbalance=Volume Imbalance;UOM=US gal"
myAnalysisTemplate.TimeRule.ConfigString = "Frequency=3600"

' Instantiate an Element from the Element Template
Dim myElement As AFElement = myDB.Elements.Add("MyElement", myElementTemplate)

' Display the Template's Name, Description, and Target
Console.WriteLine("Name = {0}", myAnalysisTemplate.Name)
Console.WriteLine("Description = {0}", myAnalysisTemplate.Description)
Console.WriteLine("Target = {0}", myAnalysisTemplate.Target.Name)

' Get the instantiated analysis from the instantiated element
Dim myAnalysis As AFAnalysis = myElement.Analyses("MyAnalysisTemplate")

' Display the Analysis's Name, Description, Target, and Template
Console.WriteLine("Name = {0}", myAnalysis.Name)
Console.WriteLine("Description = {0}", myAnalysis.Description)
Console.WriteLine("Target = {0}", myAnalysis.Target)
Console.WriteLine("Template = {0}", myAnalysis.Template.Name)

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.