Class Ai
Version 1.0
Modified 26-MAY-2023 14:29:26.00
 Analog input.

 Configures an analog input signal in the Plant
 Configuration.

Hints
 Put the object below a $PlantHier object in the
 development environment in such a way that it belongs
 to the same target node as its associated channel
 object.

Object graph


RtBody attributes pwr_sClass_Ai
String80 Description   Optional text, e.g. name of the signal or what it
represents.
AttrRef SigChanCon   Name of the associated channel object.
UInt32 ValueIndex   Index in the AIValue array of the Ai_Value_Base objects
that are used for base frequency and partial frequency
samples. Initiated at boot time by rs_init.
Pointer to Float32 ActualValue   Pointer to the engineering value, named ActualValue.
Float32 InitialValue   InitialValue specifies starting value of the signal at
so called 'cold start'. Which value that is used as
starting value at warm restart ( = change of PLC
program ) depends on whether the signal is new or not.
If the signal has exist in the last program its last
value will be used as starting value, otherwise InitialValue
String16 Unit   Engineering unit of ActualValue.
UInt8 NoOfDecimals   Number of decimals at presentation of ActualValue.
Float32 PresMaxLimit   The lower respectively upper limits in the bar graph at
presentation of ActualValue in the object display.
Float32 PresMinLimit  
Float32 SigValue   Signal value.
UInt16 RawValue   Raw value, i.e. normally the bit pattern of
A/D-converter.
XttMethodsMask XttMethodsMask   Xtt method configuration.
Specification of the available methods for the object.
If Flags.IsConfigured is set, the methods can be specified in
the development environment. Otherwise they will be calculated
in runtime.
AttrRef DefGraph   A XttGraph object that will open a graph for this object.
AttrRef DefTrend   A trend object that displays a trend for this object.
String40 HelpTopic   A help topic for this hierarchy.
URL DataSheet   An URL to the data sheet for the equipment in this hierarchy.
URL CircuitDiagram   An URL to the circuit diagram for the equipment in this hierarchy.
URL Photo   A photograph of the plant.
String80 Note   A note of the current status of the object.
AiFilterTypeEnum FilterType   The internal filter function concerns only local
Ai-signals.
Specifies the selected filter. The possible types of
filters are:

0 -- No filtering.

1 -- Exponential filter.
The filtering is done on the engineering value,
ActualValue, before storage in rtdb according:

ActualValue(t) = ActualValue(t-1) + a * (InValue - ActualValue(t-1))

where
- ActualValue(t-1) is the engineering value stored at the
former sample
- nValue(t) the current engineering value before filtering.
- a = ScanInterval * ScanTime / FilterAttribute[0]
and 0 < a < 1.0

If a >= 0 no filtering is done. The less a the harder
filtering.

The product ScanInterval * ScanTime specifies the updating
period of the signal
Array of Float32 FilterAttribute   Defines filter constants in selected function, see
FilterType. The constants are specified in seconds.
Only if FilterType = 1 and FilterAttribute[0] >
ScanInterval * CycleTimeBus (= the updating period of
the signal) is filtering done.


Template Object


Attributes detail


Description Attribute
Class Attribute
Type String80
Flags
Body RtBody
 Optional text, e.g. name of the signal or what it
 represents.

SigChanCon Attribute
Class Attribute
Type AttrRef
Flags
Body RtBody
 Name of the associated channel object.

ValueIndex Attribute
Class Attribute
Type UInt32
Flags INVISIBLE | STATE | PRIVATE
Body RtBody
 Index in the AIValue array of the Ai_Value_Base objects
 that are used for base frequency and partial frequency
 samples. Initiated at boot time by rs_init.

ActualValue Attribute
Class Attribute
Type Pointer to Float32
Flags POINTER | STATE | REDUTRANSFER
Body RtBody
 Pointer to the engineering value, named ActualValue.

InitialValue Attribute
Class Attribute
Type Float32
Flags
Body RtBody
 InitialValue specifies starting value of the signal at
 so called 'cold start'. Which value that is used as
 starting value at warm restart ( = change of PLC
 program ) depends on whether the signal is new or not.
 If the signal has exist in the last program its last
 value will be used as starting value, otherwise InitialValue

Unit Attribute
Class Attribute
Type String16
Flags
Body RtBody
 Engineering unit of ActualValue.

NoOfDecimals Attribute
Class Attribute
Type UInt8
Flags
Body RtBody
 Number of decimals at presentation of ActualValue.

PresMaxLimit Attribute
Class Attribute
Type Float32
Flags REDUTRANSFER
Body RtBody
 The lower respectively upper limits in the bar graph at
 presentation of ActualValue in the object display.

PresMinLimit Attribute
Class Attribute
Type Float32
Flags REDUTRANSFER
Body RtBody

SigValue Attribute
Class Attribute
Type Float32
Flags STATE
Body RtBody
 Signal value.

RawValue Attribute
Class Attribute
Type UInt16
Flags STATE
Body RtBody
 Raw value, i.e. normally the bit pattern of
 A/D-converter.

XttMethodsMask Attribute
Class Attribute
Type XttMethodsMask
Flags CLASS
Body RtBody
 Xtt method configuration.
 Specification of the available methods for the object.
 If Flags.IsConfigured is set, the methods can be specified in
 the development environment. Otherwise they will be calculated
 in runtime.

DefGraph Attribute
Class Attribute
Type AttrRef
Flags
Body RtBody
 A XttGraph object that will open a graph that contains data for
 this object. This graph can be opened from the popup menu for
 this object.

DefTrend Attribute
Class Attribute
Type AttrRef
Flags
Body RtBody
 A DsTrend or PlotGroup object that contains a trend for this object.
 The trend can be opened from the popup menu for this object.

HelpTopic Attribute
Class Attribute
Type String40
Flags
Body RtBody
 A help topic in the xtt help file that contains help for this hierarchy.
 The help can be displayed from the popup menu for this object.

DataSheet Attribute
Class Attribute
Type URL
Flags
Body RtBody
 An URL to the data sheet for the equipment in this hierarchy.
 The data sheet can be displayed from the popup menu for this object.

CircuitDiagram Attribute
Class Attribute
Type URL
Flags
Body RtBody
 An URL to the circuit diagram for the equipment in this hierarchy.
 The circuit diagram can be displayed from the popup menu for this object.

 If the attribute is empty, the CircuitDiagram method will look at the
 closest ancestor that has supplied a value in CircuitDiagram and use this
 URL instead. If this behavior is unwanted, put the string 'Disabled' in the
 attribute. This will disable the CircuitDiagram method for this object, and
 for any child with empty CircuitDiagram attribute.

Photo Attribute
Class Attribute
Type URL
Flags
Body RtBody
 A photograph of the plant.
 A URL to a photo of the equipment.
 The photo can be displayed from the popup menu for this object.

Note Attribute
Class Attribute
Type String80
Flags
Body RtBody
 A note of the current status of the object.
 Notes are used to exchange information between operators. It is handled
 by the Note method.

FilterType Attribute
Class Attribute
Type AiFilterTypeEnum
Flags REDUTRANSFER
Body RtBody
 The internal filter function concerns only local
 Ai-signals.
 Specifies the selected filter. The possible types of
 filters are:

 0 -- No filtering.

 1 -- Exponential filter.
    The filtering is done on the engineering value,
    ActualValue, before storage in rtdb according:

    ActualValue(t) = ActualValue(t-1) + a * (InValue - ActualValue(t-1))

    where
    - ActualValue(t-1) is the engineering value stored at the
      former sample
    - nValue(t) the current engineering value before filtering.
    - a = ScanInterval * ScanTime / FilterAttribute[0]
      and 0 < a < 1.0

    If a >= 0 no filtering is done. The less a the harder
    filtering.

    The product ScanInterval * ScanTime specifies the updating
    period of the signal

FilterAttribute Attribute
Class Attribute
Type Array of Float32
Flags ARRAY | REDUTRANSFER
Elements 4
Body RtBody
 Defines filter constants in selected function, see
 FilterType. The constants are specified in seconds.
 Only if FilterType = 1 and FilterAttribute[0] >
 ScanInterval * CycleTimeBus (= the updating period of
 the signal) is filtering done.