FB_CobotController - RegisterLoggerPoint (Method)

Overview

Type:	Method
Available as of:	V1.0.1.0

This chapter provides information on:

Task
Description
Interface
Diagnostic Messages

Task

The function block is used to register the function block to the Application Logger.

Description

The function block is registered to the Application Logger using the name transferred at the input i_sName. The parent logger point must be defined by the input i_ifParent.

For further information, refer to Using the Application Logger

Interface

Input	Data type	Description
i_ifParent	APL.IF_LoggerPoint	The parent logger point under which the function block is registered.
i_sName	STRING[80]	The name of the logger.

Output	Data type	Description
q_xError	BOOL	Value is TRUE if an error was detected. For details, refer to q_etResult and q_sResultMsg.
q_etResult	ET_Result	Provides diagnostic and status information as a numeric value. If q_xError = FALSE, q_etResult provides status information. If q_xError = TRUE, q_etResult provides diagnostic/error information.
q_sResultMsg	STRING[80]	Provides additional diagnostic and status information as a text value.

Output

Data type

Description

q_xError

BOOL

Value is TRUE if an error was detected. For details, refer to q_etResult and q_sResultMsg.

q_etResult

ET_Result

Provides diagnostic and status information as a numeric value.

If q_xError = FALSE, q_etResult provides status information. If q_xError = TRUE, q_etResult provides diagnostic/error information.

q_sResultMsg

STRING[80]

Provides additional diagnostic and status information as a text value.

Diagnostic Messages

q_xError	q_etResult	Enumeration value	Description
FALSE	Ok	0	The method was called successfully.
FALSE	LoggerPointAlreadyRegistered	31	The logger point is already registered.
TRUE	MaxNumberOfLoggerPointsExeeded	32	The maximum number of logger points was exceeded.
TRUE	NameInvalid	30	The name is invalid.
TRUE	ParentInvalid	34	The parent is invalid.
TRUE	ParentNotRegistered	35	The parent is not registered.
TRUE	ResultUnknown	8	The result is undefined.
TRUE	ServiceNotRegistered	33	The service is not registered.

LoggerPointAlreadyRegistered

Enumeration name:	LoggerPointAlreadyRegistered
Enumeration value:	31
Description:	The logger point is already registered.

The logger point is already registered in the Application Logger.

MaxNumberOfLoggerPointsExceeded

Enumeration name:	MaxNumberOfLoggerPointsExceeded
Enumeration value:	32
Description:	The maximum number of logger points was exceeded.

Issue	Cause	Solution
The method was not called successfully.	There are already APL.Gc_udiMaxNumberOfLoggerPoints logger points registered in the Application Logger (the Application Logger itself is also a logger point).	Set the global parameter APL.Gc_udiMaxNumberOfLoggerPoints to a greater value to register the number of logger points required by the project.

NameInvalid

Enumeration name:	NameInvalid
Enumeration value:	30
Description:	The name is invalid.

Issue	Cause	Solution
The method was not called successfully.	An invalid name was transferred at the input i_sName.	Ensure that at the input i_sName no empty string is transferred.

Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	The method was called successfully.

ParentInvalid

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

Issue	Cause	Solution
The method was not called successfully.	An invalid object was transferred at the input i_ifParent.	Ensure that at the input i_ifParent a valid interface of type APL.IF_LoggerPoint is transferred.

ParentNotRegistered

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

Issue	Cause	Solution
The method was not called successfully.	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 at the Application Logger first.

ResultUnknown

Enumeration name:	ResultUnknown
Enumeration value:	8
Description:	The result is undefined.

Registering the function block as logger point to the Application Logger was not successful.

ServiceNotRegistered

Enumeration name:	ServiceNotRegistered
Enumeration value:	33
Description:	The service is not registered.

Issue	Cause	Solution
The method was not called successfully.	The Application Logger communication service is not registered.	The communication service of the Application Logger must be registered first. The method APL.IF_ApplicationLogger.RegisterCommunicationService must be called successfully before a logger point can be registered at the Application Logger.

Issue

Cause

Solution

The method was not called successfully.

The Application Logger communication service is not registered.

The communication service of the Application Logger must be registered first.

The method APL.IF_ApplicationLogger.RegisterCommunicationService must be called successfully before a logger point can be registered at the Application Logger.