NDDSConfigLogger Class Reference
[Configuration Utilities]

<<interface>> The singleton type used to configure RTI Data Distribution Service logging. More...

List of all members.

Public Member Functions

NDDS_Config_LogVerbosity get_verbosity ()
 Get the verbosity at which RTI Data Distribution Service is currently logging diagnostic information.
NDDS_Config_LogVerbosity get_verbosity_by_category (NDDS_Config_LogCategory category)
 Get the verbosity at which RTI Data Distribution Service is currently logging diagnostic information in the given category.
void set_verbosity (NDDS_Config_LogVerbosity verbosity)
 Set the verbosity at which RTI Data Distribution Service will log diagnostic information.
void set_verbosity_by_category (NDDS_Config_LogCategory category, NDDS_Config_LogVerbosity verbosity)
 Set the verbosity at which RTI Data Distribution Service will log diagnostic information in the given category.
FILE * get_output_file ()
 Get the file to which the logged output is redirected.
bool set_output_file (FILE *out)
 Set the file to which the logged output is redirected.
NDDS_Config_LogPrintFormat get_print_format ()
 Get the current message format that RTI Data Distribution Service is using to log diagnostic information.
bool set_print_format (NDDS_Config_LogPrintFormat print_format)
 Set the message format that RTI Data Distribution Service will use to log diagnostic information.

Static Public Member Functions

static NDDSConfigLoggerget_instance ()
 Get the singleton instance of this type.
static void finalize_instance ()


Detailed Description

<<interface>> The singleton type used to configure RTI Data Distribution Service logging.

Member Function Documentation

static NDDSConfigLogger* NDDSConfigLogger::get_instance (  )  [static]

Get the singleton instance of this type.

static void NDDSConfigLogger::finalize_instance (  )  [static]

NDDS_Config_LogVerbosity NDDSConfigLogger::get_verbosity (  ) 

Get the verbosity at which RTI Data Distribution Service is currently logging diagnostic information.

The default verbosity if DDSLogger::set_verbosity is never called is DDS_NDDS_CONFIG_LOG_VERBOSITY_ERROR.

If DDSLogger::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.

NDDS_Config_LogVerbosity NDDSConfigLogger::get_verbosity_by_category ( NDDS_Config_LogCategory  category  ) 

Get the verbosity at which RTI Data Distribution Service is currently logging diagnostic information in the given category.

The default verbosity if DDSLogger::set_verbosity and DDSLogger::set_verbosity_by_category are never called is DDS_NDDS_CONFIG_LOG_VERBOSITY_ERROR.

void NDDSConfigLogger::set_verbosity ( NDDS_Config_LogVerbosity  verbosity  ) 

Set the verbosity at which RTI Data Distribution Service will log diagnostic information.

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

void NDDSConfigLogger::set_verbosity_by_category ( NDDS_Config_LogCategory  category,
NDDS_Config_LogVerbosity  verbosity 
)

Set the verbosity at which RTI Data Distribution Service will log diagnostic information in the given category.

FILE* NDDSConfigLogger::get_output_file (  ) 

Get the file to which the logged output is redirected.

If no output file has been registered through DDSLogger::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.

bool NDDSConfigLogger::set_output_file ( FILE *  out  ) 

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).

NDDS_Config_LogPrintFormat NDDSConfigLogger::get_print_format (  ) 

Get the current message format that RTI Data Distribution Service is using to log diagnostic information.

If DDSLogger::set_print_format is never called, the default format is DDS_NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT.

bool NDDSConfigLogger::set_print_format ( NDDS_Config_LogPrintFormat  print_format  ) 

Set the message format that RTI Data Distribution Service will use to log diagnostic information.


RTI Data Distribution Service C++ API Version 4.5e Copyright © 23 Oct 2011 Real-Time Innovations, Inc