FB_ALY_ThresholdClassificator_1Ch

Threshold Classifier 1Ch classifies the input values into three different classes: OK, Warning and Alarm according to the configured thresholds.

Syntax

Definition:

FUNCTION_BLOCK FB_ALY_ThresholdClassificator_1Ch
VAR_OUTPUT 
    ipResultMessage: Tc3_EventLogger.I_TcMessage;
    bError: BOOL;
    bNewResult: BOOL;
    bConfigured: BOOL;
    eClass: E_ALY_Classification_3Cls;
    fbTimeLastEventWarning: FB_ALY_DateTime;
    fbTimeLastEventAlarm: FB_ALY_DateTime;
END_VAR

Outputs

Name	Type	Description
ipResultMessage	I_TcMessage	Contains more detailed information on the current return value. This special interface pointer is internally secured so that it is always valid/assigned.
bError	BOOL	This output is `TRUE` if an error occurs.
bNewResult	BOOL	When a new result has been calculated, the output is `TRUE.`
bConfigured	BOOL	Displays `TRUE` when the function block is successfully configured.
eClass	E_ALY_Classification_3Cls	Classification result.
fbTimeLastEventWarning	FB_ALY_DateTime	Timestamp of the last classification as a warning.
fbTimeLastEventAlarm	FB_ALY_DateTime	Timestamp of the last classification as an alarm.

Methods

Name	Definition location	Description
Call()	Local	Method for calculating the outputs for a specific configuration.
Configure()	Local	General configuration of the algorithm with its parameterized conditions.
Reset()	Local	Resets all internal states or the calculations performed so far.
SetChannelValue()	Local	Method for passing values to the algorithm.

Properties

Name	Type	Access	Definition location	Initial value	Description
fTolerance	LREAL	Get, Set	Local	0.0	Tolerance value for the Equal / NotEqual comparisons

Sample

VAR
    fbThresholdClassificator : FB_ALY_ThresholdClassificator_1Ch;
    fbSystemTime : FB_ALY_GetSystemTime;
    fThresholdLevelOkWarning : LREAL := 10;
    fThresholdLevelWarningAlarm : LREAL:= 20;
    bConfigure : BOOL := TRUE;
    nInput : INT;
END_VAR

// Configure algorithm
IF bConfigure THEN
    bConfigure := FALSE;

    fbThresholdClassificator.Configure(fThresholdLevelOkWarning, fThresholdLevelWarningAlarm);
END_IF

// Get current system time
fbSystemTime.Call();

// Call algorithm
fbThresholdClassificator.SetChannelValue(nInput);
fbThresholdClassificator.Call(fbSystemTime.tSystemTime);

Requirements

Development environment	Target platform	Plc libraries to include
TwinCAT v3.1.4024.0	PC or CX (x64, x86)	Tc3_Analytics

Further Information