FB_AxisModule - RegisterLoggerPoint (Method)

Overview

Type:	Method
Available as of:	1.4.0.0

Task

The method registers the internal logger point in the Application Logger.

Description

The function block contains a logger point implemented for the Application Logger. After successfully calling-up this method, the function block sends messages to the Application Logger via this logger point. This method is identical to the call-up of the RegisterLoggerPoint method at APL.FB_LoggerPoint.

After registration:

oThe function block automatically sends messages to the Application Logger.

o The APL.ET_LogLevel enumeration (logger level) describes the type and importance of a message.

oDepending on the logger level (ET_LogLevel), various information is send to the Application Logger.

APL.ET_LogLevel	Information sent to the Application Logger
10 (EmergencyMessage)...40 (Warning)	Messages, exceptions and warnings, reported by the function block
50 (UserAction)...60 (ExternalEvent)	Commands, sent to the function block
70 (StatusMessage)	Status changes at the outputs of the function block
80 (DebugMessage)	Internal messages (for expert debugging only)

Interface

Input	Data type	Description
i_ifParent	APL.IF_LoggerPoint	The parent logger point under which the logger point of the function block is to be registered. The global variable G_ifApplicationLogger is also a logger point.
i_sName	STRING[80]	The name of the function block logger point that shall be displayed in the Application Logger has to be defined here.

Output	Data type	Description
q_etDiag	GD.ET_Diag	General, library-independent statement on the diagnosis. A value not equal to ET_Diag.Ok corresponds to an error message.
q_etDiagExt	ET_DiagExt	POU-specific output on the diagnostic. q_etDiag = ET_Diag.Ok -> Status message q_etDiag <> ET_Diag.Ok -> Error message

Output

Data type

Description

q_etDiag

GD.ET_Diag

General, library-independent statement on the diagnosis.

A value not equal to ET_Diag.Ok corresponds to an error message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Error message

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Ok
InputParameterInvalid	MaxNumberOfLoggerPointsExeeded	163	The maximum number of logger points is exceeded.
InputParameterInvalid	ParentInvalid	161	The parent is invalid.
InputParameterInvalid	ParentNotRegistered	162	The parent is not registered.
UnexpectedProgramBehavior	UnexpectedDiagExt	158	An unexpected error occurred during the execution.

MaxNumberOfLoggerPointsExeeded

Enumeration name:	MaxNumberOfLoggerPointsExeeded
Enumeration value:	163
Description:	The maximum number of logger points is exceeded.

Issue	Cause	Solution
-	It was attempted to register more than APL.Gc_udiMaxNumberOfLoggerPoints logger points in the application logger.	The global parameter APL.Gc_udiMaxNumberOfLoggerPoints must be increased.

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The logger point was successfully registered in the Application Logger.

ParentInvalid

Enumeration name:	ParentInvalid
Enumeration value:	161
Description:	The parent is invalid.

Issue	Cause	Solution
-	An invalid object has been transferred at the input i_ifParent.	At the input i_ifParent an object of the type APL.FB_LoggerPoint or APL.IF_ApplicationLogger has to be transferred.

ParentNotRegistered

Enumeration name:	ParentNotRegistered
Enumeration value:	162
Description:	The parent is not registered.

Issue	Cause	Solution
-	The logger points transferred at the input i_ifParent is not registered in the Application Logger.	The logger point transferred at the input i_ifParent must be registered in the Application Logger first.

UnexpectedDiagExt

Enumeration name:	UnexpectedDiagExt
Enumeration value:	158
Description:	An unexpected error occurred during the execution.

Issue	Cause	Solution
-	An error occurred in the internal execution.	Please inform the support team about this error.