IF_StandardFilter

 

IF_StandardFilter - General Information

Overview

Type:

Interface

Available as of:

V 1.0.0.0

Inherits from:

Versions:

Current version

Task

Supports filter operations on variables of the default interface ST_StandardItf.

Description

The IF_StandardFilter interface specifies three switches that refer to either a group of variables or to individual variables from the ST_StandardItf structure.

oActivity switch:

Groups the variables i_xEnable, q_xActive and q_xReady from ST_StandardItf to a filter unit. If the xEnableActivity property of IF_StandardFilter is set to FALSE, these three variables are no longer enabled.

oCommands switch:

Defines iq_diCMD from ST_StandardItf as filter variable If the xEnableCommands property of IF_StandardFilter is set to FALSE, this variable is no longer enabled.

oExceptions switch:

Defines i_xDiagQuit from ST_StandardItf as filter variable If the xEnableExceptions property of IF_StandardFilter is set to FALSE, this variable is no longer enabled.

Filtering, enabling or not enabling variables has a specific meaning that depends on the intended use. In the case of the FB_ModuleLogger, for instance, change tracking and logging are enabled or disabled for the variable group or an individual variable.

Properties

Name

Data type

Accessing

Description

xEnableActivity

BOOL

Read/Write

TRUE: The variable group i_xEnable, q_xActive and q_xReady is enabled (read) or is being enabled (write).

FALSE: The variable group i_xEnable, q_xActive and q_xReady is not enabled (read) or is not being enabled (write).

xEnableCommands

BOOL

Read/Write

TRUE: The variable iq_diCMD is enabled (read) or is being enabled (write).

FALSE: The variable iq_diCMD is not enabled (read) or is not being enabled (write).

xEnableExceptions

BOOL

Read/Write

TRUE: The variable i_xDiagQuit is enabled (read) or is being enabled (write).

FALSE: The variable i_xDiagQuit is not enabled (read) or is not being enabled (write).