Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
next_best_view::DebugHelper Class Reference

The DebugHelper class is responsible for debug output. More...

#include <DebugHelper.hpp>

Public Types

enum  DebugLevel {
  PARAMETERS = 1, SERVICE_CALLS = 2, VISUALIZATION = 4, CALCULATION = 8,
  RATING = 16, ROBOT_MODEL = 32, MAP = 64, FILTER = 128,
  IK_RATING = 256, SPACE_SAMPLER = 512, HYPOTHESIS_UPDATER = 1024, WORLD = 2048,
  VOXEL_GRID = 4096
}
 

Public Member Functions

unsigned int getLevel ()
 returns the debug level that is set More...
 
std::string getLevelString ()
 returns the debug levels that are set as string More...
 
void setLevels (std::string levelsStr)
 sets levels from the given string More...
 
void setLevels ()
 sets the allowed debug levels More...
 
void write (const char *text, DebugLevel level)
 writes the text to the console if it has a level that allows it More...
 
void write (const std::string &text, DebugLevel level)
 writes the text to the console if it has a level that allows it More...
 
void write (const std::ostream &text, DebugLevel level)
 writes the text to the console if it has a level that allows it More...
 
void writeNoticeably (const char *text, DebugLevel level)
 writes the text noticeably to the console if it has a level that allows it More...
 
void writeNoticeably (const std::string &text, DebugLevel level)
 writes the text noticeably to the console if it has a level that allows it More...
 
void writeNoticeably (const std::ostream &text, DebugLevel level)
 writes the text noticeably to the console if it has a level that allows it More...
 

Static Public Member Functions

static boost::shared_ptr< DebugHelpergetInstance ()
 

Private Member Functions

bool checkLevel (DebugLevel level)
 checks whether the given level is allowed More...
 
 DebugHelper ()
 

Static Private Member Functions

static void addToString (std::string &s, const std::string &add)
 adds a string to a given string s. Puts a comma between them if the string s has a size bigger than 0. More...
 
static int parseLevels (std::vector< std::string > levels)
 parses the level list to the corresponding integer More...
 

Private Attributes

unsigned int mLevels
 
ros::NodeHandle mNodeHandle
 

Static Private Attributes

static const int ALL
 
static boost::shared_ptr< DebugHelperinstancePtr
 
static const int NONE = 0
 

Detailed Description

The DebugHelper class is responsible for debug output.

Definition at line 32 of file DebugHelper.hpp.

Member Enumeration Documentation

Enumerator
PARAMETERS 
SERVICE_CALLS 
VISUALIZATION 
CALCULATION 
RATING 
ROBOT_MODEL 
MAP 
FILTER 
IK_RATING 
SPACE_SAMPLER 
HYPOTHESIS_UPDATER 
WORLD 
VOXEL_GRID 

Definition at line 36 of file DebugHelper.hpp.

Constructor & Destructor Documentation

next_best_view::DebugHelper::DebugHelper ( )
private

Definition at line 35 of file DebugHelper.cpp.

Member Function Documentation

void next_best_view::DebugHelper::addToString ( std::string &  s,
const std::string &  add 
)
staticprivate

adds a string to a given string s. Puts a comma between them if the string s has a size bigger than 0.

Parameters
s[in,out] the string
add[in] the string to add

Definition at line 224 of file DebugHelper.cpp.

bool next_best_view::DebugHelper::checkLevel ( DebugLevel  level)
private

checks whether the given level is allowed

Parameters
levelthe level
Returns
whether the given level is allowed. true if it is allowed and false if it is not.

Definition at line 142 of file DebugHelper.cpp.

boost::shared_ptr< DebugHelper > next_best_view::DebugHelper::getInstance ( )
static

Definition at line 29 of file DebugHelper.cpp.

unsigned int next_best_view::DebugHelper::getLevel ( )

returns the debug level that is set

Returns
the debug level that is set.

Definition at line 86 of file DebugHelper.cpp.

std::string next_best_view::DebugHelper::getLevelString ( )

returns the debug levels that are set as string

Returns
the debug levels that are set as string.

Definition at line 91 of file DebugHelper.cpp.

int next_best_view::DebugHelper::parseLevels ( std::vector< std::string >  levels)
staticprivate

parses the level list to the corresponding integer

Parameters
levelsthe list of level strings
Returns
the corresponding integer

Definition at line 164 of file DebugHelper.cpp.

void next_best_view::DebugHelper::setLevels ( std::string  levelsStr)

sets levels from the given string

Parameters
levelsStrthe string, comma seperated list of levels, which may contain [] braces

Definition at line 152 of file DebugHelper.cpp.

void next_best_view::DebugHelper::setLevels ( )

sets the allowed debug levels

Definition at line 146 of file DebugHelper.cpp.

void next_best_view::DebugHelper::write ( const char *  text,
DebugHelper::DebugLevel  level 
)

writes the text to the console if it has a level that allows it

Parameters
textthe text
levelthe debug level of the text

Definition at line 40 of file DebugHelper.cpp.

void next_best_view::DebugHelper::write ( const std::string &  text,
DebugLevel  level 
)

writes the text to the console if it has a level that allows it

Parameters
textthe text
levelthe debug level of the text

Definition at line 47 of file DebugHelper.cpp.

void next_best_view::DebugHelper::write ( const std::ostream &  text,
DebugLevel  level 
)

writes the text to the console if it has a level that allows it

Parameters
textthe text
levelthe debug level of the text

Definition at line 53 of file DebugHelper.cpp.

void next_best_view::DebugHelper::writeNoticeably ( const char *  text,
DebugHelper::DebugLevel  level 
)

writes the text noticeably to the console if it has a level that allows it

Parameters
textthe text
levelthe debug level of the text

Definition at line 61 of file DebugHelper.cpp.

void next_best_view::DebugHelper::writeNoticeably ( const std::string &  text,
DebugHelper::DebugLevel  level 
)

writes the text noticeably to the console if it has a level that allows it

Parameters
textthe text
levelthe debug level of the text

Definition at line 70 of file DebugHelper.cpp.

void next_best_view::DebugHelper::writeNoticeably ( const std::ostream &  text,
DebugHelper::DebugLevel  level 
)

writes the text noticeably to the console if it has a level that allows it

Parameters
textthe text
levelthe debug level of the text

Definition at line 77 of file DebugHelper.cpp.

Member Data Documentation

const int next_best_view::DebugHelper::ALL
staticprivate
boost::shared_ptr< DebugHelper > next_best_view::DebugHelper::instancePtr
staticprivate

Definition at line 54 of file DebugHelper.hpp.

unsigned int next_best_view::DebugHelper::mLevels
private

Definition at line 61 of file DebugHelper.hpp.

ros::NodeHandle next_best_view::DebugHelper::mNodeHandle
private

Definition at line 60 of file DebugHelper.hpp.

const int next_best_view::DebugHelper::NONE = 0
staticprivate

Definition at line 58 of file DebugHelper.hpp.


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


asr_next_best_view
Author(s): Aumann Florian, Borella Jocelyn, Heller Florian, Meißner Pascal, Schleicher Ralf, Stöckle Patrick, Stroh Daniel, Trautmann Jeremias, Walter Milena, Wittenbeck Valerij
autogenerated on Thu Jan 9 2020 07:20:18