Index

Package: DDS.Logger

Description

package DDS.Logger is

Classes

Ref 

type Ref is new RTIDDS.Obj_Impl.Ref with null record;

Primitive operations:

Get_Instance
Get_Print_Format
Get_Verbosity
Get_Verbosity
Set_Output_Device
Set_Print_Format
Set_Verbosity
Set_Verbosity

Types

Ref_Access 

type Ref_Access is access all Ref'Class;

LoggerDevice_Interface (abstract) 

type LoggerDevice_Interface is limited interface;

Subprograms & Entries

Get_Instance 

function Get_Instance return access Ref;

Summary: Get the singleton instance of this type.

Get_Verbosity 

function Get_Verbosity 
(This: not null access Ref) return LogVerbosity;

Summary: Get the verbosity at which RTI Connext is currently logging diagnostic information.

The default verbosity if NDDSConfigLogger.set_verbosity is never called is NDDS_CONFIG_LOG_VERBOSITY_ERROR.

If NDDSConfigLogger.set_verbosity_by_category has been used to set different verbosities for different categories of messages, this procedure will return the maximum verbosity of all categories.

Get_Verbosity 

function Get_Verbosity 
(This:    not null access Ref;
Category: in LogCategory) return LogVerbosity;

Summary: Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category.

The default verbosity if NDDSConfigLogger.set_verbosity and NDDSConfigLogger.set_verbosity_by_category are never called is NDDS_CONFIG_LOG_VERBOSITY_ERROR.

Set_Verbosity 

procedure Set_Verbosity 
(This:    not null access Ref;
Verbosity: in LogVerbosity);

Summary: Set the verbosity at which RTI Connext will log diagnostic information.

Note: Logging at high verbosities will be detrimental to your application's performance. Your default setting should typically remain at NDDS_CONFIG_LOG_VERBOSITY_WARNING or below. (The default verbosity if you never set it is NDDS_CONFIG_LOG_VERBOSITY_ERROR.)

Set_Verbosity 

procedure Set_Verbosity 
(This:    not null access Ref;
Category: in LogCategory;
Verbosity: in LogVerbosity);

Summary: Set the verbosity at which RTI Connext will log diagnostic information in the given category.

Get_Print_Format 

function Get_Print_Format 
(This: not null access Ref) return LogPrintFormat;

Summary: Get the current message format for the log level NDDS_CONFIG_LOG_LEVEL_ERROR.

Use NDDSConfigLogger.get_print_format_by_log_level to retrieve the format for other log levels.

If NDDSConfigLogger.set_print_format is never called, the default format is NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

Set_Print_Format 

procedure Set_Print_Format 
(This: not null access Ref;
Format: LogPrintFormat);

Summary: Set the message format that RTI Connext will use to log diagnostic information for all the log levels, except for NDDS_CONFIG_LOG_LEVEL_FATAL_ERROR. When the DDSActivityContextModule is printed, the user can select the information that will be part of the DDSActivityContextModule by using the API NDDSConfigActivityContext.set_attribute_mask.

Write (abstract) 

procedure Write 
(Self: LoggerDevice_Interface;
Text: Standard.String;
Level: LogVerbosity) is abstract;

Close 

procedure Close 
(Self: LoggerDevice_Interface) is null;

GetDevice (abstract) 

function GetDevice 
(Self: access LoggerDevice_Interface) return access RTIDDS.Low_Level.ndds_ndds_config_c_h.NDDS_Config_LoggerDevice is abstract;

GetLogger (abstract) 

function GetLogger 
(Self: access LoggerDevice_Interface) return DDS.Logger.Ref_Access is abstract;

Set_Output_Device 

procedure Set_Output_Device 
(Self: not null access DDS.Logger.Ref;
Device: access LoggerDevice_Interface'Class);