Class BaseActuatorIncrDecr
Version 1.0
Modified 24-OCT-2008 13:54:46.04
 Base component for an actuator with digital increment/decrement orders, position
 feedback and two switches (switch open and switch closed).

 The buttons for increment and decrement in the object graph can be configure to show
 Incr/Decr, Up/Down, Forw/Back or Open/Close.

 BaseActuatorIncrDecr is for example used in BaseValveIncrDecr.

Object Graph

Mode
 The mode, Auto, Manual or Local, is handled by the mode object. See class
 CompModeD2 for more information.

Supervision
 If the actuator has limit switches, also the switches are supervised. If a
 positional feedback signal is present, the switches are matched against this
 signal. If the position is below 'PosSwitchClosed' and the SwitchClosed signal is
 missing, an alarm is sent. If the position is over 'PosSwitchOpen' and the
 SwitchOpen signal is missing, an alarm is sent.
 If both switches are simultaneously activated, an alarm is also sent.

 Supervision of limit switch timeout is handled by the CompModeD2 object, where
 the timeout time is set in the attribute OrderTimeLimit. A timeout error in
 auto mode causes a switch to manual mode. See CompModeD2 for info how to disable
 this function.

 If you choose not to use the handling of modes in the object, but place this
 outside the object, it is important to reset the order at error status, i.e.
 you should reset the function object inputs at error, to avoid unwanted restarts.
 Use for example ErrorIncr and ErrorDecr in the CompModeD2 object that detects
 timeout errors when limit switches are configured.

Configuration


 Component Configuration
 There are eight configuration alternatives, that specifies whether the actuator
 has limit switches and/or positional feedback.

 - TwoSwitches            Switch open and switch closed. No positional feedback.
 - SwitchOpen             Switch open and no positional feedback.
 - SwitchClosed           Switch closed and no positional feedback.
 - NoSwitches             No switches and no positional feedback.
 - PositionTwoSwitches    Positional feedback, switch open and switch closed.
 - PositionSwitchOpen     Positional feedback and switch open.
 - PositionSwitchClosed   Positional feedback and switch closed.
 - PositionNoSwitches     Positional feedback and no switches.

Signals
 Signals that should be connected to channel objects:

 - OrderIncr    Do
 - OrderDecr    Do
 - Position     Ai (optional)
 - SwitchOpen   Di (optional)
 - SwitchClosed Di (optional)

Plc coding
 For plc coding the function object BaseActuatorIncrDecrFo is used.
 Create a function object in the plc editor and connect it to the current
 object with the connect function.

See also



RtBody attributes pwr_sClass_BaseActuatorIncrDecr
Component Super   Super class.
BaseActuatorAGCEnum GraphConfiguration   Enumeration for object graph configuration.
Handled by the ConfigureComponent method.
Do OrderIncr   The increment order output.
Do OrderDecr   The decrement order output.
Ai Position   Analog input signal for the position feedback.
Di SwitchOpen   Digital input switch open.
Di SwitchClosed   Digital input switch closed.
CompModeD2 Mode   Mode object.
Float32 SwitchAlarmDelay   Delay for switch alarm in seconds.
DSupComp SwitchAlarm   Alarm text for switch alarm.
Float32 PosSwitchOpen   Position for limitswitch open.
If the position feedback (or ordered position, if feedback is
not present) exceeds this value, and the switch open signal is
missing, an switch alarm is sent.
Float32 PosSwitchClosed   Position for limitswitch closed.
If the position feedback (or ordered position, if feedback is
not present) is below this value, and the switch closed signal is
missing, an switch alarm is sent.
Boolean IndError   Indication for error.
Boolean IndWarning   Indication for warning.
Boolean SwitchError   A switch error is detected.
ValvePosEnum PosEnum   Enumeration for valve position (open, closed or in between).
Boolean SupDisabled   Supervision is disabled.
AttrRef PlcConnect   The plc function object connected to this object.
AttrRef SimConnect   The simulate plc function object connected to this object.


Template Object
Position.Unit %
Position.PresMaxLimit 1.000000e+02
Mode.OpNoLocal 1
Mode.OpNoAutoToMan 1
Mode.OrderTimeLimit 1.000000e+01
Mode.AlarmNotReadyM.DetectOn 1
Mode.AlarmNotReadyM.DetectText Check interlocks. Manual start is not allowed, not ready
Mode.AlarmNotReadyM.EventType 64
Mode.AlarmNotReadyM.EventPriority 66
Mode.AlarmNotReadyM.EventFlags 7
Mode.AlarmNotReadyM.MoreText
Mode.AlarmNotReadyM.Attribute BaseComponent:Class-BaseActuatorIncrDecr-Template
Mode.AlarmNotReadyM.CtrlPosition 1
Mode.AlarmNotReadyM.LockAttribute 1
Mode.AlarmNotReadyA.DetectOn 1
Mode.AlarmNotReadyA.DetectText Check interlocks. Automode is not allowed, not ready
Mode.AlarmNotReadyA.EventType 64
Mode.AlarmNotReadyA.EventPriority 66
Mode.AlarmNotReadyA.EventFlags 7
Mode.AlarmNotReadyA.MoreText
Mode.AlarmNotReadyA.Attribute BaseComponent:Class-BaseActuatorIncrDecr-Template
Mode.AlarmNotReadyA.CtrlPosition 1
Mode.AlarmNotReadyA.LockAttribute 1
Mode.Alarm1LocalMod.DetectOn 1
Mode.Alarm1LocalMod.DetectText Local mode is activated, remote control is not allowed
Mode.Alarm1LocalMod.EventType 64
Mode.Alarm1LocalMod.EventPriority 66
Mode.Alarm1LocalMod.EventFlags 7
Mode.Alarm1LocalMod.MoreText
Mode.Alarm1LocalMod.Attribute BaseComponent:Class-BaseActuatorIncrDecr-Template
Mode.Alarm1LocalMod.CtrlPosition 1
Mode.Alarm1LocalMod.LockAttribute 1
Mode.Alarm2LocalMod.DetectOn 1
Mode.Alarm2LocalMod.DetectText Local mode is activated
Mode.Alarm2LocalMod.EventType 64
Mode.Alarm2LocalMod.EventPriority 66
Mode.Alarm2LocalMod.EventFlags 7
Mode.Alarm2LocalMod.MoreText
Mode.Alarm2LocalMod.Attribute BaseComponent:Class-BaseActuatorIncrDecr-Template
Mode.Alarm2LocalMod.CtrlPosition 1
Mode.Alarm2LocalMod.LockAttribute 1
Mode.AlarmNotManOrd.DetectOn 1
Mode.AlarmNotManOrd.DetectText Automode active. Manual order is not allowed
Mode.AlarmNotManOrd.EventType 64
Mode.AlarmNotManOrd.EventPriority 66
Mode.AlarmNotManOrd.EventFlags 7
Mode.AlarmNotManOrd.MoreText
Mode.AlarmNotManOrd.Attribute BaseComponent:Class-BaseActuatorIncrDecr-Template
Mode.AlarmNotManOrd.CtrlPosition 1
Mode.AlarmNotManOrd.LockAttribute 1
Mode.AlarmOrderTimeOut.DetectOn 1
Mode.AlarmOrderTimeOut.DetectText Timeout, limit switch not reached
Mode.AlarmOrderTimeOut.EventType 64
Mode.AlarmOrderTimeOut.EventPriority 67
Mode.AlarmOrderTimeOut.EventFlags 7
Mode.AlarmOrderTimeOut.MoreText
Mode.AlarmOrderTimeOut.Attribute BaseComponent:Class-BaseActuatorIncrDecr-Template
Mode.AlarmOrderTimeOut.CtrlPosition 1
Mode.AlarmOrderTimeOut.LockAttribute 1
SwitchAlarmDelay 1.000000e+01
SwitchAlarm.DetectOn 1
SwitchAlarm.DetectText Switch error
SwitchAlarm.EventType 64
SwitchAlarm.EventPriority 67
SwitchAlarm.EventFlags 7
SwitchAlarm.MoreText
SwitchAlarm.Attribute BaseComponent:Class-CompModeD-Template
SwitchAlarm.CtrlPosition 1
SwitchAlarm.LockAttribute 1
PosSwitchOpen 9.500000e+01
PosSwitchClosed 5.000000e+00


Attributes detail


Super Attribute
Class Attribute
Type Component
Flags Class|Superclass
Body RtBody
 Super class.

GraphConfiguration Attribute
Class Attribute
Type BaseActuatorAGCEnum
Flags
Body RtBody
 Enumeration for object graph configuration.
 Handled by the ConfigureComponent method.

OrderIncr Attribute
Class Attribute
Type Do
Flags Class
Body RtBody
 The increment order output.

OrderDecr Attribute
Class Attribute
Type Do
Flags Class
Body RtBody
 The decrement order output.

Position Attribute
Class Attribute
Type Ai
Flags Class|DisableAttr
Body RtBody
 Analog input signal for the position feedback.

SwitchOpen Attribute
Class Attribute
Type Di
Flags Class|DisableAttr
Body RtBody
 Digital input switch open.

SwitchClosed Attribute
Class Attribute
Type Di
Flags Class|DisableAttr
Body RtBody
 Digital input switch closed.

Mode Attribute
Class Attribute
Type CompModeD2
Flags Class
Body RtBody
 Mode object.

SwitchAlarmDelay Attribute
Class Attribute
Type Float32
Flags ReduTransfer|DisableAttr
Body RtBody
 Delay for switch alarm in seconds.

SwitchAlarm Attribute
Class Attribute
Type DSupComp
Flags Class|DisableAttr
Body RtBody
 Alarm text for switch alarm.

PosSwitchOpen Attribute
Class Attribute
Type Float32
Flags ReduTransfer
Body RtBody
 Position for limitswitch open.
 If the position feedback (or ordered position, if feedback is
 not present) exceeds this value, and the switch open signal is
 missing, an switch alarm is sent.

PosSwitchClosed Attribute
Class Attribute
Type Float32
Flags ReduTransfer
Body RtBody
 Position for limitswitch closed.
 If the position feedback (or ordered position, if feedback is
 not present) is below this value, and the switch closed signal is
 missing, an switch alarm is sent.

IndError Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 Indication for error.

IndWarning Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 Indication for warning.

SwitchError Attribute
Class Attribute
Type Boolean
Flags ReduTransfer|Noedit
Body RtBody
 A switch error is detected.

PosEnum Attribute
Class Attribute
Type ValvePosEnum
Flags ReduTransfer
Body RtBody
 Enumeration for valve position (open, closed or in between).

SupDisabled Attribute
Class Attribute
Type Boolean
Flags ReduTransfer
Body RtBody
 Supervision is disabled.
 Shows the input DisableSup in the plc Fo object.

PlcConnect Attribute
Class Attribute
Type AttrRef
Flags
Body RtBody
 The plc function object connected to this object.
 This attribute is set when the function object is connected from
 the plc editor by the connect function.

SimConnect Attribute
Class Attribute
Type AttrRef
Flags
Body RtBody
 The simulate plc function object connected to this object.
 This attribute is set when the simulate function object is connected from
 the plc editor by the connect function.