Public Member Functions | Private Attributes
Diagnosics Class Reference

Diagnostics class for status reporting of common libraries. More...

#include <Diagnostics.h>

List of all members.

Public Member Functions

 Diagnosics ()
 Constructor.
int GetActualStatusQueLength ()
 status que length
int GetDefaultOKValue ()
 Default ok value read/write.
int GetMaxStatusQueLength ()
 Gets the maximal length of status history that can be read.
void ReadActualStatus (short *Level, std::string *Message, std::string *Recommendation)
 Read the status.
int ReadActualStatusLevel ()
 Retuns the actual status level.
std::string ReadActualStatusMessage ()
 Retuns the actual status message.
std::string ReadActualStatusRecommendation ()
 Retuns the actual status recommendation.
void ReportStatus (short Level, std::string Message)
 Report a Status.
void ReportStatus (short Level, std::string Message, std::string Recommendation)
 for simple status report by hand with problem solution
void ReportStatus (short Level, int Errorcode, std::string Errorcode_Namespace, std::string Recommendation)
 report with manually set level for a errorcode and additional comments
void ReportStatus (int Errorcode, std::string Errorcode_Namespace)
 automatic report of status by errorcode. Can be used for return values of library functions.
void SetDefaultOKValue (int Default_Ok_Value)
 sets a new default ok value
void SetMaxStatusQueLength (int StatusQueLength)
 Sets the maximal length of status history that can be read. Default is 5 elements.
 ~Diagnosics ()
 Destructor.

Private Attributes

int m_Default_Ok_Value
std::deque< DiagnosticStatus > * m_StatusList
int m_StatusQueLength

Detailed Description

Diagnostics class for status reporting of common libraries.

This class is ment to provide a easy and short way to report the status (Errors and non-Errors) to the library itself and to ROS. It is designed close to the diagnostics msg topic to be easly wrapped.

Definition at line 116 of file Diagnostics.h.


Constructor & Destructor Documentation

Diagnosics::Diagnosics ( ) [inline]

Constructor.

Definition at line 127 of file Diagnostics.h.

Destructor.

Definition at line 142 of file Diagnostics.h.


Member Function Documentation

status que length

returns the Status que length right now

Definition at line 275 of file Diagnostics.h.

Default ok value read/write.

returns the actual default ok value

Definition at line 302 of file Diagnostics.h.

Gets the maximal length of status history that can be read.

Definition at line 291 of file Diagnostics.h.

void Diagnosics::ReadActualStatus ( short *  Level,
std::string *  Message,
std::string *  Recommendation 
) [inline]

Read the status.

Outputs the actual status to the passed pointers.

string arguments are resized for the message

Definition at line 225 of file Diagnostics.h.

Retuns the actual status level.

Definition at line 242 of file Diagnostics.h.

std::string Diagnosics::ReadActualStatusMessage ( ) [inline]

Retuns the actual status message.

Definition at line 251 of file Diagnostics.h.

Retuns the actual status recommendation.

Definition at line 260 of file Diagnostics.h.

void Diagnosics::ReportStatus ( short  Level,
std::string  Message 
) [inline]

Report a Status.

for simple status report by hand

Definition at line 156 of file Diagnostics.h.

void Diagnosics::ReportStatus ( short  Level,
std::string  Message,
std::string  Recommendation 
) [inline]

for simple status report by hand with problem solution

Definition at line 171 of file Diagnostics.h.

void Diagnosics::ReportStatus ( short  Level,
int  Errorcode,
std::string  Errorcode_Namespace,
std::string  Recommendation 
) [inline]

report with manually set level for a errorcode and additional comments

Definition at line 187 of file Diagnostics.h.

void Diagnosics::ReportStatus ( int  Errorcode,
std::string  Errorcode_Namespace 
) [inline]

automatic report of status by errorcode. Can be used for return values of library functions.

Definition at line 205 of file Diagnostics.h.

void Diagnosics::SetDefaultOKValue ( int  Default_Ok_Value) [inline]

sets a new default ok value

Definition at line 310 of file Diagnostics.h.

void Diagnosics::SetMaxStatusQueLength ( int  StatusQueLength) [inline]

Sets the maximal length of status history that can be read. Default is 5 elements.

Definition at line 283 of file Diagnostics.h.


Member Data Documentation

Definition at line 320 of file Diagnostics.h.

Definition at line 317 of file Diagnostics.h.

Definition at line 319 of file Diagnostics.h.


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


schunk_powercube_chain
Author(s): Florian Weisshardt
autogenerated on Thu Aug 27 2015 15:06:58