Project: bml_lib

License: BSD

Dependencies:

Used by:

All Packages

edu::wpi::hri::log::ROSLogger Class Reference

Inheritance diagram for edu::wpi::hri::log::ROSLogger:

List of all members.

Public Member Functions

void debug (LoggerLevel level, String str)
void error (String str)
void fatal (String str, int exitCode)
void info (String str)
void warn (String str)

Package Functions

 ROSLogger (LoggerLevel level, Colors color, String name)

Private Attributes

final Ros rosInst

Detailed Description

Log messages via the ROS routines. If ROS has not been initialized, the RosException thrown by ROS will continue to be passed along by any of the Logging methods.

Author:
Aaron Holroyd (aholroyd (at) wpi (dot) edu)

Definition at line 46 of file ROSLogger.java.


Constructor & Destructor Documentation

edu::wpi::hri::log::ROSLogger::ROSLogger ( LoggerLevel  level,
Colors  color,
String  name 
) [inline, package]

Create a new ROSLogger which always prints the given name in the specified color before printing any message given.

Parameters:
color The color of the name to display
name The name of where the message came from.

Definition at line 59 of file ROSLogger.java.


Member Function Documentation

void edu::wpi::hri::log::ROSLogger::debug ( LoggerLevel  level,
String  str 
) [inline, virtual]

Print a debug string to the user so long as the user wants to see debugging.

Parameters:
level The minimum level required to print this message.
str The message to tell the user

Implements edu::wpi::hri::log::Logger.

Definition at line 65 of file ROSLogger.java.

void edu::wpi::hri::log::ROSLogger::error ( String  str  )  [inline, virtual]

Print an error string to the user so long as the user wants to see errors.

Parameters:
str The message to tell the user

Implements edu::wpi::hri::log::Logger.

Definition at line 81 of file ROSLogger.java.

void edu::wpi::hri::log::ROSLogger::fatal ( String  str,
int  exitCode 
) [inline, virtual]

Print a fatal string to the user and then exit the program. The specified exit code will be used when calling the System.exit() routine.

Parameters:
str The message to tell the user
exitCode The exit code for why the program had to stop

Implements edu::wpi::hri::log::Logger.

Definition at line 86 of file ROSLogger.java.

void edu::wpi::hri::log::ROSLogger::info ( String  str  )  [inline, virtual]

Print an info string to the user so long as the user wants to see information.

Parameters:
str The message to tell the user

Implements edu::wpi::hri::log::Logger.

Definition at line 71 of file ROSLogger.java.

void edu::wpi::hri::log::ROSLogger::warn ( String  str  )  [inline, virtual]

Print a warning string to the user so long as the user wants to see warning messages.

Parameters:
str The message to tell the user

Implements edu::wpi::hri::log::Logger.

Definition at line 76 of file ROSLogger.java.


Member Data Documentation

Definition at line 48 of file ROSLogger.java.


The documentation for this class was generated from the following file:

bml_lib
Author(s): Aaron Holroyd (aholroyd (at) wpi (dot) edu)
autogenerated on Fri Sep 9 10:44:08 2011