LGF_IsValueInRange (FC / V3.0.1)

Overview

Author: Siemens Digital Industries

Short description

The function checks whether a value is within a defined value range.
The value range is defined with a set point and a range around this set point. The function calculates the low limit and high limit of the value range.

Block Interface

LGF_IsValueInRange (FC)
LReal  value Ret_Val  Bool
    
LReal  setpoint overHighLimit  Bool
    
LReal  range belowLowLimit  Bool
    
   error  Bool
    
   status  Word
    
   

Input parameter

IdentifierData type Description
valueLReal Value to be checked to determine whether it is within the defined value range
setpointLReal Set point
rangeLReal Area where the setpoint is in range

Output parameter

IdentifierData type Description
Ret_ValBool Return: TRUE if the “value” is in the value range (range of the set point)
overHighLimitBool TRUE if the “value” is greater than the upper limit value
belowLowLimitBool TRUE, if the “value” is less than the lower limit value
errorBool FALSE: No error
TRUE: An error occurred during the execution of the FB
statusWord 16#0000-16#7FFF: Status of the FB
16#8000-16#FFFF: Error identification (see following Table)

Status & Error codes

Code / ValueIdentifier / Description
16#0000STATUS_NO_ERROR
Status: no error occurred
16#8401ERR_RANGE_LIMIT_VALUES
Error: During calculating of the limit values

Functional description

The setpoint and range variables define a range of values.
The function checks whether the value is below, in or above the value range. The outputs belowLowLimit, Ret_Val, or overHighLimit show where the value is located.

Figure: Principle of operation

LGF_IsValueInRange - Principle of operation

Change log

Version & DateChange description
01.00.00Siemens Industry Online Support
30.01.2017First released version
01.00.01Siemens Industry Online Support
17.08.2018Upgrade: TIA V15 Update 2
01.00.02Siemens Industry Online Support
23.11.2018Upgrade: TIA V15.1
01.01.00Simatic Systems Support
13.11.2019renamed from "LGF_HighLowLimit" to "LGF_IsValueInRange"
Code refactoring
error values changed, regions, comments and constant’s are added
03.00.00Simatic Systems Support
23.04.2020Set version to V3.0.0, harmonize the version of the whole library
03.00.01Simatic Systems Support
12.11.2020Insert documentation