Logger Class Reference
[Configuration Utilities]

<<interface>> The singleton type used to configure RTI Connext logging. More...

List of all members.

Public Member Functions
LogVerbosity	get_verbosity ()
	Get the verbosity at which RTI Connext is currently logging diagnostic information.
LogVerbosity	get_verbosity_by_category (LogCategory category)
	Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category.
void	set_verbosity (LogVerbosity verbosity)
	Set the verbosity at which RTI Connext will log diagnostic information.
void	set_verbosity_by_category (LogCategory category, LogVerbosity verbosity)
	Set the verbosity at which RTI Connext will log diagnostic information in the given category.
File	get_output_file ()
	Get the file to which the logged output is redirected.
void	set_output_file (File out) throws IOException
	Set the file to which the logged output is redirected.
LogPrintFormat	get_print_format ()
	Get the current message format that RTI Connext is using to log diagnostic information.
boolean	set_print_format (LogPrintFormat print_format)
	Set the message format that RTI Connext will use to log diagnostic information.
Static Public Member Functions
static Logger	get_instance ()
	Get the singleton instance of this type.

---

Detailed Description

<<interface>> The singleton type used to configure RTI Connext logging.

---

Member Function Documentation

static Logger get_instance

(

)

[static]

Get the singleton instance of this type.

LogVerbosity get_verbosity

(

)

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

The default verbosity if com.rti.ndds.config.Logger.set_verbosity is never called is com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_ERROR.

If com.rti.ndds.config.Logger.set_verbosity_by_category has been used to set different verbosities for different categories of messages, this method will return the maximum verbosity of all categories.

LogVerbosity get_verbosity_by_category

(

LogCategory

category

)

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

The default verbosity if com.rti.ndds.config.Logger.set_verbosity and com.rti.ndds.config.Logger.set_verbosity_by_category are never called is com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_ERROR.

void set_verbosity

(

LogVerbosity

verbosity

)

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 com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_WARNING or below. (The default verbosity if you never set it is com.rti.ndds.config.LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_ERROR.)

void set_verbosity_by_category	(	LogCategory	category,
		LogVerbosity	verbosity
	)

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

File get_output_file

(

)

Get the file to which the logged output is redirected.

If no output file has been registered through com.rti.ndds.config.Logger.set_output_file, this method will return NULL. In this case, logged output will on most platforms go to standard out as if through printf.

void set_output_file

(

File

out

)

throws IOException

Set the file to which the logged output is redirected.

The file passed may be NULL, in which case further logged output will be redirected to the platform-specific default output location (standard out on most platforms).

LogPrintFormat get_print_format

(

)

Get the current message format that RTI Connext is using to log diagnostic information.

If com.rti.ndds.config.Logger.set_print_format is never called, the default format is com.rti.ndds.config.LogPrintFormat.NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

boolean set_print_format

(

LogPrintFormat

print_format

)

Set the message format that RTI Connext will use to log diagnostic information.