AFDataReference.UpdateValues Method (AFValues, AFUpdateOption, AFBufferOption)

Public Overridable Function UpdateValues ( 
	values As AFValues,
	updateOption As AFUpdateOption,
	bufferOption As AFBufferOption
) As AFErrors(Of AFValue)

Dim instance As AFDataReference
Dim values As AFValues
Dim updateOption As AFUpdateOption
Dim bufferOption As AFBufferOption
Dim returnValue As AFErrors(Of AFValue)

returnValue = instance.UpdateValues(values, 
	updateOption, bufferOption)

public:
virtual AFErrors<AFValue^>^ UpdateValues(
	AFValues^ values, 
	AFUpdateOption updateOption, 
	AFBufferOption bufferOption
)

abstract UpdateValues : 
        values : AFValues * 
        updateOption : AFUpdateOption * 
        bufferOption : AFBufferOption -> AFErrors<AFValue> 
override UpdateValues : 
        values : AFValues * 
        updateOption : AFUpdateOption * 
        bufferOption : AFBufferOption -> AFErrors<AFValue> 

' This example demonstrates how to update values to an attribute with PIPoint data reference.
' Note: For successul write through Buffer, PI Buffer Subsystem needs to be correctly pre-configured with PI Buffer Manager. 

' Get the Database and UOMs
Dim myPISystems As PISystems = New PISystems
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
Dim myDB As AFDatabase = myPISystem.Databases.DefaultDatabase
Dim uomFoot As UOM = myPISystem.UOMDatabase.UOMs("foot")
Dim uomYard As UOM = myPISystem.UOMDatabase.UOMs("yard")

' Create an Attribute and its new values
Dim myAttribute As AFAttribute = Nothing
Dim newStartTime As AFTime = New AFTime("T-1d", CultureInfo.CurrentCulture)
Dim newValues As AFValues = New AFValues
Dim randomValues As Random = New Random()

' Create Dynamic Attribute to a PIPoint to Update
Dim piServer As PIServer = PIServers.GetPIServers.DefaultPIServer
Dim dataCount As Integer = 5 'Create 5 new values to update
Dim newTime As AFTime = newStartTime
Dim point As PIPoint = Nothing
If Not PIPoint.TryFindPIPoint(piServer, "MyTestPoint#1", point) Then
    point = piServer.CreatePIPoint("MyTestPoint#1")
End If
myAttribute = New AFAttribute(String.Format(CultureInfo.InvariantCulture, "\\{0}\{1}", piServer.Name, point.Name))
myAttribute.DefaultUOM = uomFoot
myAttribute.ConfigString = (myAttribute.ConfigString + ";ReadOnly=False")
For i As Integer = 1 To dataCount
    Dim newValue As AFValue = New AFValue(myAttribute, randomValues.NextDouble(), newTime, uomYard)
    newValues.Add(newValue)
    newTime = newTime.LocalTime.AddMinutes(10)
Next
Dim newEndTime As AFTime = newTime

' Get the Recorded Values for the Attribute
Dim recordedValues As AFValues = myAttribute.Data.RecordedValues(New AFTimeRange(newStartTime, newEndTime), AFBoundaryType.Inside,
    myAttribute.DefaultUOM, Nothing, False)
Console.WriteLine("Recorded Values:")
For Each value As AFValue In recordedValues
    Console.WriteLine("  {0}: '{1} {2}' at '{3}'",
        value.Attribute, value.Value, value.UOM, value.Timestamp)
Next

' Get the Buffer Option
' Note: If not specified in AFSDK.config, the buffer option is defaulted to "BufferIfPossible". 
Console.WriteLine("Current Buffer Option: {0}", AFData.BufferOption)

' Set the Buffer Option to "Buffer" if it is not already, which will be valid throughout this client instance.
If Not AFData.BufferOption.Equals(AFBufferOption.Buffer) Then
    AFData.BufferOption = AFBufferOption.Buffer
    Console.WriteLine("Current Buffer Option for this instance has been changed to: {0}", AFData.BufferOption)
End If

'1. Update the Attribute Values and Display any Errors
Dim errorsWithBuffer As AFErrors(Of AFValue) =
    myAttribute.Data.UpdateValues(newValues, AFUpdateOption.InsertNoCompression) 'Insert or InsertNoCompression
Thread.Sleep(1000)

If Not errorsWithBuffer Is Nothing AndAlso errorsWithBuffer.HasErrors Then
    Console.WriteLine("Errors returned from AFAttribute.Data.UpdateValues:")

    ' Display Value errors
    If Not errorsWithBuffer.Errors Is Nothing AndAlso errorsWithBuffer.Errors.Count > 0 Then
        For Each item As KeyValuePair(Of AFValue, Exception) In errorsWithBuffer.Errors
            Console.WriteLine("  AFValue '{0}': {1}", item.Key, item.Value)
        Next
    End If

    ' Display PI Data Archive error
    If Not errorsWithBuffer.PIServerErrors Is Nothing AndAlso errorsWithBuffer.PIServerErrors.Count > 0 Then
        For Each item As KeyValuePair(Of PIServer, Exception) In errorsWithBuffer.PIServerErrors
            Console.WriteLine("  AFValue '{0}': {1}", item.Key, item.Value)
        Next
    End If

    ' Display PI System errors
    If Not errorsWithBuffer.PISystemErrors Is Nothing AndAlso errorsWithBuffer.PISystemErrors.Count > 0 Then
        For Each item As KeyValuePair(Of PISystem, Exception) In errorsWithBuffer.PISystemErrors
            Console.WriteLine("  AFValue '{0}': {1}", item.Key, item.Value)
        Next
    End If
End If


'2. Alternatively, one can specify buffer option in the UpdateValues method
Dim errorsWithBufferIfPossible As AFErrors(Of AFValue) =
    myAttribute.Data.UpdateValues(newValues, AFUpdateOption.InsertNoCompression, AFBufferOption.BufferIfPossible)
Thread.Sleep(1000)

' Get the Updated Recorded Values for the Attributes
Dim recordedValuesUpdated As AFValues = myAttribute.Data.RecordedValues(New AFTimeRange(newStartTime, newEndTime), AFBoundaryType.Inside,
    myAttribute.DefaultUOM, Nothing, False)
Console.WriteLine("Updated Recorded Values:")
For Each value As AFValue In recordedValuesUpdated
    Console.WriteLine("  {0}: '{1} {2}' at '{3}'",
        value.Attribute, value.Value, value.UOM, value.Timestamp)
Next

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.