Public Member Functions | Private Attributes
OCL::HMIConsoleOutput Class Reference

This component can be used to display messages on the standard output. More...

#include <HMIConsoleOutput.hpp>

Inheritance diagram for OCL::HMIConsoleOutput:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void display (const std::string &what)
 Display a message on standard output.
void displayBool (bool what)
 Display a boolean on standard output.
void displayDouble (double what)
 Display a double on standard output.
void displayInt (int what)
 Display an integer on standard output.
template<class T >
void dolog (const T &what)
void enableColor (bool yesno=true)
template<class T >
void enqueue (const T &what)
 HMIConsoleOutput (const std::string &name="cout")
void log (const std::string &what)
void logBool (bool what)
 Log a boolean on standard output.
void logDouble (double what)
 Log a double on standard output.
void logInt (int what)
 Log an integer on standard output.
void setPrompt (const std::string &prompt)
void updateHook ()
 ~HMIConsoleOutput ()

Private Attributes

std::string _prompt
std::ostringstream backup
std::string coloroff
std::string coloron
RTT::os::Mutex log_lock
std::ostringstream logbackup
std::ostringstream logmessages
std::ostringstream messages
RTT::os::Mutex msg_lock

Detailed Description

This component can be used to display messages on the standard output.

It is known as the 'cout' component in scripts.

HMI == Human-Machine Interface

Definition at line 50 of file HMIConsoleOutput.hpp.


Constructor & Destructor Documentation

OCL::HMIConsoleOutput::HMIConsoleOutput ( const std::string &  name = "cout") [inline]

Definition at line 65 of file HMIConsoleOutput.hpp.

Definition at line 81 of file HMIConsoleOutput.hpp.


Member Function Documentation

void OCL::HMIConsoleOutput::display ( const std::string &  what) [inline]

Display a message on standard output.

Definition at line 131 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::displayBool ( bool  what) [inline]

Display a boolean on standard output.

Definition at line 163 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::displayDouble ( double  what) [inline]

Display a double on standard output.

Definition at line 179 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::displayInt ( int  what) [inline]

Display an integer on standard output.

Definition at line 171 of file HMIConsoleOutput.hpp.

template<class T >
void OCL::HMIConsoleOutput::dolog ( const T &  what) [inline]

Definition at line 185 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::enableColor ( bool  yesno = true) [inline]

Enable or disable using a colored prompt.

Definition at line 108 of file HMIConsoleOutput.hpp.

template<class T >
void OCL::HMIConsoleOutput::enqueue ( const T &  what) [inline]

Put a message in the queue. The message must be convertible to a stream using operator<<().

Definition at line 142 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::log ( const std::string &  what) [inline]

Definition at line 203 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::logBool ( bool  what) [inline]

Log a boolean on standard output.

Definition at line 210 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::logDouble ( double  what) [inline]

Log a double on standard output.

Definition at line 226 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::logInt ( int  what) [inline]

Log an integer on standard output.

Definition at line 218 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::setPrompt ( const std::string &  prompt) [inline]

Set the prompt text.

Definition at line 122 of file HMIConsoleOutput.hpp.

void OCL::HMIConsoleOutput::updateHook ( ) [inline, virtual]

Reimplemented from RTT::base::TaskCore.

Definition at line 86 of file HMIConsoleOutput.hpp.


Member Data Documentation

std::string OCL::HMIConsoleOutput::_prompt [private]

Definition at line 55 of file HMIConsoleOutput.hpp.

Definition at line 57 of file HMIConsoleOutput.hpp.

std::string OCL::HMIConsoleOutput::coloroff [private]

Definition at line 54 of file HMIConsoleOutput.hpp.

std::string OCL::HMIConsoleOutput::coloron [private]

Definition at line 53 of file HMIConsoleOutput.hpp.

Definition at line 62 of file HMIConsoleOutput.hpp.

Definition at line 59 of file HMIConsoleOutput.hpp.

Definition at line 58 of file HMIConsoleOutput.hpp.

Definition at line 56 of file HMIConsoleOutput.hpp.

Definition at line 61 of file HMIConsoleOutput.hpp.


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


ocl
Author(s): OCL Development Team
autogenerated on Mon Sep 14 2015 14:21:47