FB_RoboticModule - RegisterLoggerPoint (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

This chapter provides information on:

oTask

oDescription

oInterface

oDiagnostic Messages

Task

By calling this method, the RoboticModule is being registered to the application logger.

Description

The RoboticModule is registered to the global application logger.

Further information can be found under Using the ApplicationLogger in this help.

Interface

Input

Data type

Description

i_ifParent

APL.IF_LoggerPoint

Parent logger point under which the RoboticModule is registered.

i_sName

STRING[80]

The name of the RoboticModule logger point that is shown in the application logger has to be declared here.

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic.

A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = GD.ET_Diag.Ok -> Status message

q_etDiag <> GD.ET_Diag.Ok -> Diagnostic message

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

LoggerPointAlreadyRegistered

240

The logger point is already registered.

OK

Ok

0

Ok

ExecutionAborted

MaxNumberOfLoggerPointsExceeded

241

The maximum number of logger points was exceeded.

ExecutionAborted

ServiceNotRegistered

242

The service is not registered.

InputParameterInvalid

ParentInvalid

243

The parent is invalid.

InputParameterInvalid

ParentNotRegistered

244

The parent is not registered.

UnexpectedProgramBehavior

UnexpectedFeedback

28

A feedback value was invalid.

LoggerPointAlreadyRegistered

Enumeration name:

LoggerPointAlreadyRegistered

Enumeration value:

240

Description:

The logger point is already registered.

Registering the function block FB_RoboticModule as logger point to the application logger was successful.

The logger point is already registered in the application logger.

MaxNumberOfLoggerPointsExceeded

Enumeration name:

MaxNumberOfLoggerPointsExceeded

Enumeration value:

241

Description:

The maximum number of logger points was exceeded.

Issue

Cause

Solution

Registering the function block FB_RoboticModule as logger point to the application logger was not successful.

There are already Gc_udiMaxNumberOfLoggerPoints logger points registered in the application logger. (The application logger itself is also a logger point).

The global parameter Gc_udiMaxNumberOfLoggerPoints has to be set to a greater value to register the logger points of the project.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

Registering the function block FB_RoboticModule as logger point to the application logger was successful.

ParentInvalid

Enumeration name:

ParentInvalid

Enumeration value:

243

Description:

The parent is invalid.

Issue

Cause

Solution

Registering the function block FB_RoboticModule as logger point to the application logger was not successful.

An invalid object has been transferred at the input i_ifParent.

Ensure that at the input i_ifParent an object of the type APL.FB_LoggerPoint or APL.IF_ApplicationLogger is transferred.

ParentNotRegistered

Enumeration name:

ParentNotRegistered

Enumeration value:

244

Description:

The parent is not registered.

Issue

Cause

Solution

Registering the function block FB_RoboticModule as logger point to the application logger was not successful.

The logger point 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.

ServiceNotRegistered

Enumeration name:

ServiceNotRegistered

Enumeration value:

242

Description:

The service is not registered.

Issue

Cause

Solution

 Registering the function block FB_RoboticModule as logger point to the application logger was not successful.

The application logger communication service is not registered.

The communication service of the application logger has to be registered first.

The method APL.IF_ApplicationLogger.RegisterCommunicationService has to be called successfully once before a logger point can be registered in the application logger.

UnexpectedFeedback

Enumeration name:

UnexpectedFeedback

Enumeration value:

28

Description:

A feedback value was invalid.

Registering the function block FB_RoboticModule as logger point to the application logger was not successful.