TagRemoveForceFB Function Block

Introduction

The TagRemoveForceFB Function Block removes any forced value from a Data Point Tag.

The function block removes the force value by sending a RemoveForce Tag Command to the tag. The function block provides status information to:

Monitor the progress of the tag command.
Report whether the tag command succeeded or failed.

The TagRemoveForceFB Function Block is intended for use with:

If no fixed value has been applied to the tag, TagRemoveForceFB has no effect.

Functions and Function Blocks

The TagRemoveForceFB Function Block is intended for use in a Program Tag that runs on the Fernhill SCADA Server. A Program Tag uses a continuous execution model, where the program code runs at a fixed interval. A program uses the function block to sample the state of the tag command as it executes.

If you want to remove a force from a tag in an Operator Action, use the TagRemoveForce Function.

Syntax

The TagRemoveForceFB Function Block has this syntax:

TagRemoveForceFB(
        REQ:=Expression,
        TAGNAME:=Expression,
        BUSY=>Variable-Reference,
        DONE=>Variable-Reference,
        ERROR=>Variable-Reference,
        ERRORMSG=>Variable-Reference );

Note: All parameters are optional.

Parameters

The TagRemoveForceFB Function Block has these parameters:

Parameter	Type	Direction	Description
REQ	BOOL R_EDGE	Input	A rising edge starts the RemoveForce Tag Command.
TAGNAME	STRING	Input	The name of the tag to send the RemoveForce Tag Command to. This can be an absolute tag name, or a relative tag name. Relative tag names are resolved relative to the full name of the host program.
BUSY	BOOL	Output	Set to TRUE while the RemoveForce Tag Command is in progress.
DONE	BOOL	Output	Set to TRUE for 1 execution after the RemoveForce Tag Command has completed.
ERROR	BOOL	Output	Set to TRUE if the RemoveForce Tag Command failed.
ERRORMSG	WSTRING	Output	If ERROR is TRUE, the reason why the RemoveForce Tag Command failed.

Remarks

Once the RemoveForce Tag Command begins, additional requests from the input signal REQ are ignored until the tag command completes.

These timing diagrams show the relationship of the REQ, BUSY, DONE, and ERROR signals processing two requests. The first request completes with an error, the second request completes normally:

        +--------+     +-+ +------+
  REQ   |        |     | | |      |
      --+        +-----+ +-+      +------

        +------+       +------+
 BUSY   |      |       |      |
      --+      +-------+      +----------

               ++             ++
 DONE          ||             ||
      ---------++-------------++---------

               +-------+
ERROR          |       |
      ---------+       +-----------------

The BUSY signal is TRUE while the tag command is in progress. The DONE signal is TRUE for 1 execution after the completion of the tag command.

Example Program

The following IEC 61131-3 Program shows:

A FALSE to TRUE transition of a digital data point tag used to trigger a function block.
A function block removing a force from another tag.
Example logic to check the status of the function block.

Program MAIN
    VAR 
        (* The function block declaration *)
        RemoveForceFB : TagRemoveForceFB;

        (* The tag used to trigger the removal of the forced value
           Note: Uses a relative tag reference to 'Digital Trigger Tag' 
                 located in the same folder as this program *)
        TriggerTag AT %".Digital Trigger Tag" : BOOL;
    END_VAR

    (* Call the TagRemoveForceFB function block *)
    RemoveForceFB( 
        REQ:=TriggerTag,
        TAGNAME:="Tag to remove force from" );

    (* The DONE output is active for one cycle when the function block completes *)
    IF RemoveForceFB.DONE THEN

        (* Was there an error ? *)
        IF RemoveForceFB.ERROR THEN
            (* Handle any error *)
        ELSE
            (* Any additional work on successful completion *)
        END_IF;
    END_IF;

END_PROGRAM

Further Information

RemoveForce Tag Command

To learn about the RemoveForce Tag Command.

Tag Command Function Blocks

To learn about other tag command function blocks.

IEC 61131-3 Expressions

To learn about the different types of expression to use as function parameters.

Elementary Data Types

To learn about the different types supported by Fernhill SCADA.

Common Elements

To learn about other IEC 61131-3 Common Elements.

Glossary

For the meaning of terms used in Fernhill SCADA.