FB_CamSwitchHmi

FB_CamSwitchHmi 1:

This class (FB) provides exactly one cam switch.

Syntax:

FUNCTION_BLOCK FB_CamSwitchHmi EXTENDS FB_BaseHmi

FB_CamSwitchHmi 2: Properties

Name

Type

Access

Initial value

Description

Name

STRING

Get, Set

<SourceName>

Specifies the name of the class instance.

FB_CamSwitchHmi

Active

BOOL

Get

FALSE

TRUE if the cam switch is within the range of the current actual value.

InUse

BOOL

Get, Set

FALSE

TRUE to activate the cam switch.

LowerRange

LREAL

Get, Set

0.0

Lower range, starting from the threshold value.

Threshold

LREAL

Get, Set

0.0

Threshold value at which the cam switch is aligned

UpperRange

LREAL

Get, Set

0.0

Upper range, starting from the threshold value,

FB_Base

BaseState

E_BaseState

Get

eNotHandled

Initialization state of the class instance.

Error

BOOL

Get

FALSE

Class is in an error state.

ResultMessage

I_AppMessage

Get

-

Access to the class-internal EventLogger.

[PROTECTED] _Name

STRING

Get

<SourceName>

.Name without leading 'fb'.

FB_CamSwitchHmi 3: Methods

Name

Description

Reset()

Resets the error state of the class.

FB_BaseHmi

Init(ipBase)

Default initialization method to pass the base class.

FB_Base

GetHMI()

Returns the assigned HMI object.

Notice The method is not implemented in the FB_Base class. If the method is not overwritten by inheritance, a pseudo variable is always returned.

SetHMI(ipBase)

General assignment method for an FB_BaseHmi extending class as a local HMI.

Notice The method is not implemented in the FB_Base class. If the method is not overridden by inheritance, it always fails.

[PROTECTED] _IsMyself(iCmp)

Identifies whether the transferred object corresponds to its own instance.

[PROTECTED] _QueryNamespace()

Extracts the first part of the instance path as an object namespace.

[PROTECTED] _QueryObjectName()

Extracts the last part of the instance path as the object name.

FB_CamSwitchHmi 4: Interfaces

Type

Description

I_Base

Standard interface on FB_Base.

I_CamsSwitchHmi

Standard interface on FB_BaseHmi.

I_BaseHmi

Standard interface on FB_BaseHmi.

I_BaseDev

Covers all methods and properties of the base class.

I_Comparable

Enables comparisons via _IsMyself() or F_IsSameInstance().

Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT 4026 >= v3.1.4026.19
TwinCAT 4024 >= v3.1.4024.71

PC or CX (x64, x86)

Tc3_PlasticBaseApplication (>= v12.14.0.0)