Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
mrpt::hwdrivers::CRoboticHeadInterface Class Reference

Detailed Description

This "software driver" implements the communication protocol for interfacing a Robotic Head Board through a custom USB RS-422 interface board.

In this class the "bind" is ignored since it is designed for USB connections only, thus it internally generate the required object for simplicity of use. The default serial number is "OREJA001"

Warning: Avoid defining an object of this class in a global scope if you want to catch all potential exceptions during the constructors (like USB interface DLL not found, etc...)

PARAMETERS IN THE ".INI"-LIKE CONFIGURATION STRINGS:
-------------------------------------------------------
[supplied_section_name]
HEAD_serialNumber=OREJA001
HEAD_gain=127,127,127
HEAD_yaw=0 // initial yaw value
HEAD_pitch=0 // initial tilt

Definition at line 48 of file CRoboticHeadInterface.h.

#include <mrpt/hwdrivers/CRoboticHeadInterface.h>

Inheritance diagram for mrpt::hwdrivers::CRoboticHeadInterface:
Inheritance graph

Public Member Functions

 CRoboticHeadInterface ()
 Constructor. More...
 
 ~CRoboticHeadInterface ()
 Destructor. More...
 
void setDeviceSerialNumber (const std::string &deviceSerialNumber)
 Changes the serial number of the device to open. More...
 
void GetGain (int &_gain, int &channel)
 Read the gain for the amplifier of the ear "channel", where channel is 0, 1 or 2. More...
 
bool SetGain (int &new_gain, int &channel)
 Set the gain for the amplifier each ear. More...
 
void GetSoundLocation (int &ang)
 This function return the angle where last sound where detected. More...
 
void Get3SoundBuffer (mrpt::math::CMatrixTemplate< int > &buf)
 Debug only!!! This function return the last 500 acquired samples for each sound channel. More...
 
void SetHeadPose (int &yaw, int &pitch)
 Move the head in: More...
 

Static Public Attributes

static mrpt::system::TConsoleColor logging_levels_to_colors [NUMBER_OF_VERBOSITY_LEVELS]
 Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor. More...
 
static std::string logging_levels_to_names [NUMBER_OF_VERBOSITY_LEVELS]
 Map from VerbosityLevels to their corresponding names. More...
 

Protected Member Functions

void loadConfig_sensorSpecific (const mrpt::config::CConfigFileBase *configSource, const std::string &iniSection)
 Loads specific configuration for the device from a given source of configuration parameters, for example, an ".ini" file, loading from the section "[iniSection]" (see config::CConfigFileBase and derived classes) See hwdrivers::CSonarSRF10 for the possible parameters. More...
 

Protected Attributes

VerbosityLevel m_min_verbosity_level
 Provided messages with VerbosityLevel smaller than this value shall be ignored. More...
 

Private Member Functions

std::string generateStringFromFormat (const char *fmt, va_list argp) const
 Helper method for generating a std::string instance from printf-like arguments. More...
 

Private Attributes

mrpt::comms::CInterfaceFTDI m_usbConnection
 
mrpt::serialization::CMessage msg
 
std::string m_serialNumber
 
std::vector< int32_tgain
 
int head_yaw
 
int head_pitch
 
std::string m_logger_name
 
std::deque< TMsgm_history
 
std::deque< output_logger_callback_t > m_listCallbacks
 

Logging methods

void logStr (const VerbosityLevel level, const std::string &msg_str) const
 Main method to add the specified message string to the logger. More...
 
void logFmt (const VerbosityLevel level, const char *fmt,...) const MRPT_printf_format_check(3
 Alternative logging method, which mimics the printf behavior. More...
 
void void logCond (const VerbosityLevel level, bool cond, const std::string &msg_str) const
 Log the given message only if the condition is satisfied. More...
 
void setLoggerName (const std::string &name)
 Set the name of the COutputLogger instance. More...
 
std::string getLoggerName () const
 Return the name of the COutputLogger instance. More...
 
void setMinLoggingLevel (const VerbosityLevel level)
 Set the minimum logging level for which the incoming logs are going to be taken into account. More...
 
void setVerbosityLevel (const VerbosityLevel level)
 alias of setMinLoggingLevel() More...
 
VerbosityLevel getMinLoggingLevel () const
 
bool isLoggingLevelVisible (VerbosityLevel level) const
 
void getLogAsString (std::string &log_contents) const
 Fill the provided string with the contents of the logger's history in std::string representation. More...
 
std::string getLogAsString () const
 Get the history of COutputLogger instance in a string representation. More...
 
void writeLogToFile (const std::string *fname_in=NULL) const
 Write the contents of the COutputLogger instance to an external file. More...
 
void dumpLogToConsole () const
 Dump the current contents of the COutputLogger instance in the terminal window. More...
 
std::string getLoggerLastMsg () const
 Return the last Tmsg instance registered in the logger history. More...
 
void getLoggerLastMsg (std::string &msg_str) const
 Fill inputtted string with the contents of the last message in history. More...
 
void loggerReset ()
 Reset the contents of the logger instance. More...
 
void logRegisterCallback (output_logger_callback_t userFunc)
 
bool logDeregisterCallback (output_logger_callback_t userFunc)
 
bool logging_enable_console_output
 [Default=true] Set it to false in case you don't want the logged messages to be dumped to the output automatically. More...
 
bool logging_enable_keep_record
 [Default=false] Enables storing all messages into an internal list. More...
 

Constructor & Destructor Documentation

◆ CRoboticHeadInterface()

CRoboticHeadInterface::CRoboticHeadInterface ( )

Constructor.

Definition at line 22 of file CRoboticHeadInterface.cpp.

References gain, head_pitch, head_yaw, m_serialNumber, MRPT_END, and MRPT_START.

◆ ~CRoboticHeadInterface()

mrpt::hwdrivers::CRoboticHeadInterface::~CRoboticHeadInterface ( )
inline

Destructor.

Definition at line 78 of file CRoboticHeadInterface.h.

Member Function Documentation

◆ dumpLogToConsole()

void COutputLogger::dumpLogToConsole ( ) const
inherited

Dump the current contents of the COutputLogger instance in the terminal window.

See also
writeToFile

Definition at line 179 of file COutputLogger.cpp.

◆ generateStringFromFormat()

std::string COutputLogger::generateStringFromFormat ( const char *  fmt,
va_list  argp 
) const
privateinherited

Helper method for generating a std::string instance from printf-like arguments.

Definition at line 99 of file COutputLogger.cpp.

References mrpt::system::os::vsnprintf().

◆ Get3SoundBuffer()

void CRoboticHeadInterface::Get3SoundBuffer ( mrpt::math::CMatrixTemplate< int > &  buf)

Debug only!!! This function return the last 500 acquired samples for each sound channel.

Definition at line 104 of file CRoboticHeadInterface.cpp.

References mrpt::serialization::archiveFrom(), mrpt::serialization::CMessage::content, m_usbConnection, msg, mrpt::math::CMatrixTemplate< T >::setSize(), and mrpt::serialization::CMessage::type.

◆ GetGain()

void CRoboticHeadInterface::GetGain ( int &  _gain,
int &  channel 
)

Read the gain for the amplifier of the ear "channel", where channel is 0, 1 or 2.

Definition at line 56 of file CRoboticHeadInterface.cpp.

References mrpt::serialization::archiveFrom(), mrpt::serialization::CMessage::content, m_usbConnection, msg, THROW_EXCEPTION, and mrpt::serialization::CMessage::type.

◆ getLogAsString() [1/2]

std::string COutputLogger::getLogAsString ( ) const
inherited

Get the history of COutputLogger instance in a string representation.

Definition at line 148 of file COutputLogger.cpp.

Referenced by mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::getDescriptiveReport().

◆ getLogAsString() [2/2]

void COutputLogger::getLogAsString ( std::string log_contents) const
inherited

Fill the provided string with the contents of the logger's history in std::string representation.

Definition at line 143 of file COutputLogger.cpp.

◆ getLoggerLastMsg() [1/2]

std::string COutputLogger::getLoggerLastMsg ( ) const
inherited

Return the last Tmsg instance registered in the logger history.

Definition at line 184 of file COutputLogger.cpp.

References mrpt::system::COutputLogger::TMsg::getAsString().

◆ getLoggerLastMsg() [2/2]

void COutputLogger::getLoggerLastMsg ( std::string msg_str) const
inherited

Fill inputtted string with the contents of the last message in history.

Definition at line 190 of file COutputLogger.cpp.

◆ getLoggerName()

std::string COutputLogger::getLoggerName ( ) const
inherited

Return the name of the COutputLogger instance.

See also
setLoggerName

Definition at line 132 of file COutputLogger.cpp.

Referenced by mrpt::system::COutputLogger::TMsg::TMsg().

◆ getMinLoggingLevel()

VerbosityLevel mrpt::system::COutputLogger::getMinLoggingLevel ( ) const
inlineinherited

◆ GetSoundLocation()

void CRoboticHeadInterface::GetSoundLocation ( int &  ang)

This function return the angle where last sound where detected.

This angle is related to the robot pose, NOT head pose.

angle > 0deg --> Sound detected in the left
angle = 0deg --> Sound detected in front of the head
angle < 0deg --> Sound detected in the right

Definition at line 91 of file CRoboticHeadInterface.cpp.

References mrpt::serialization::archiveFrom(), mrpt::serialization::CMessage::content, m_usbConnection, msg, and mrpt::serialization::CMessage::type.

◆ isLoggingLevelVisible()

bool mrpt::system::COutputLogger::isLoggingLevelVisible ( VerbosityLevel  level) const
inlineinherited

◆ loadConfig_sensorSpecific()

void CRoboticHeadInterface::loadConfig_sensorSpecific ( const mrpt::config::CConfigFileBase configSource,
const std::string iniSection 
)
protected

Loads specific configuration for the device from a given source of configuration parameters, for example, an ".ini" file, loading from the section "[iniSection]" (see config::CConfigFileBase and derived classes) See hwdrivers::CSonarSRF10 for the possible parameters.

Definition at line 41 of file CRoboticHeadInterface.cpp.

References gain, head_pitch, head_yaw, m_serialNumber, mrpt::config::CConfigFileBase::read_int(), mrpt::config::CConfigFileBase::read_string(), and mrpt::config::CConfigFileBase::read_vector().

◆ logCond()

void COutputLogger::logCond ( const VerbosityLevel  level,
bool  cond,
const std::string msg_str 
) const
inherited

Log the given message only if the condition is satisfied.

See also
log, logFmt

Definition at line 120 of file COutputLogger.cpp.

◆ logDeregisterCallback()

bool COutputLogger::logDeregisterCallback ( output_logger_callback_t  userFunc)
inherited
Returns
true if an entry was found and deleted.

Definition at line 287 of file COutputLogger.cpp.

References getAddress().

◆ logFmt()

void COutputLogger::logFmt ( const VerbosityLevel  level,
const char *  fmt,
  ... 
) const
inherited

◆ loggerReset()

void COutputLogger::loggerReset ( )
inherited

Reset the contents of the logger instance.

Called upon construction.

Definition at line 195 of file COutputLogger.cpp.

References mrpt::system::LVL_INFO.

◆ logRegisterCallback()

void COutputLogger::logRegisterCallback ( output_logger_callback_t  userFunc)
inherited

Definition at line 274 of file COutputLogger.cpp.

◆ logStr()

void COutputLogger::logStr ( const VerbosityLevel  level,
const std::string msg_str 
) const
inherited

◆ setDeviceSerialNumber()

void mrpt::hwdrivers::CRoboticHeadInterface::setDeviceSerialNumber ( const std::string deviceSerialNumber)
inline

Changes the serial number of the device to open.

Definition at line 81 of file CRoboticHeadInterface.h.

References m_serialNumber.

◆ SetGain()

bool CRoboticHeadInterface::SetGain ( int &  new_gain,
int &  channel 
)

Set the gain for the amplifier each ear.

The value range is [0x00(min) .. 0x7F(max)]. The value 0x80 set the resistor in high impedance state, DON'T USE IT!!!

Definition at line 73 of file CRoboticHeadInterface.cpp.

References mrpt::serialization::archiveFrom(), mrpt::serialization::CMessage::content, m_usbConnection, msg, and mrpt::serialization::CMessage::type.

◆ SetHeadPose()

void mrpt::hwdrivers::CRoboticHeadInterface::SetHeadPose ( int &  yaw,
int &  pitch 
)

Move the head in:

elevation = 'yaw' degrees
orientation = 'pitch' degrees

◆ setLoggerName()

void COutputLogger::setLoggerName ( const std::string name)
inherited

◆ setMinLoggingLevel()

void COutputLogger::setMinLoggingLevel ( const VerbosityLevel  level)
inherited

Set the minimum logging level for which the incoming logs are going to be taken into account.

String messages with specified VerbosityLevel smaller than the min, will not be outputted to the screen and neither will a record of them be stored in by the COutputLogger instance

Definition at line 133 of file COutputLogger.cpp.

Referenced by mrpt::maps::CRandomFieldGridMap2D::enableVerbose(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), mrpt::hwdrivers::CHokuyoURG::initialize(), and mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::loadParams().

◆ setVerbosityLevel()

void COutputLogger::setVerbosityLevel ( const VerbosityLevel  level)
inherited

◆ writeLogToFile()

void COutputLogger::writeLogToFile ( const std::string fname_in = NULL) const
inherited

Write the contents of the COutputLogger instance to an external file.

Upon call to this method, COutputLogger dumps the contents of all the logged commands so far to the specified external file. By default the filename is set to ${LOGGERNAME}.log except if the fname parameter is provided

See also
dumpToConsole, getAsString

Definition at line 154 of file COutputLogger.cpp.

References ASSERTMSG_, and mrpt::format().

Member Data Documentation

◆ gain

std::vector<int32_t> mrpt::hwdrivers::CRoboticHeadInterface::gain
private

Definition at line 54 of file CRoboticHeadInterface.h.

Referenced by CRoboticHeadInterface(), and loadConfig_sensorSpecific().

◆ head_pitch

int mrpt::hwdrivers::CRoboticHeadInterface::head_pitch
private

Definition at line 55 of file CRoboticHeadInterface.h.

Referenced by CRoboticHeadInterface(), and loadConfig_sensorSpecific().

◆ head_yaw

int mrpt::hwdrivers::CRoboticHeadInterface::head_yaw
private

Definition at line 55 of file CRoboticHeadInterface.h.

Referenced by CRoboticHeadInterface(), and loadConfig_sensorSpecific().

◆ logging_enable_console_output

bool mrpt::system::COutputLogger::logging_enable_console_output
inherited

[Default=true] Set it to false in case you don't want the logged messages to be dumped to the output automatically.

Definition at line 239 of file system/COutputLogger.h.

◆ logging_enable_keep_record

bool mrpt::system::COutputLogger::logging_enable_keep_record
inherited

[Default=false] Enables storing all messages into an internal list.

See also
writeLogToFile, getLogAsString

Definition at line 242 of file system/COutputLogger.h.

◆ logging_levels_to_colors

mrpt::system::TConsoleColor COutputLogger::logging_levels_to_colors
staticinherited
Initial value:

Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor.

Implementation file for the COutputLogger header class.

Handy for coloring the input based on the verbosity of the message

Definition at line 124 of file system/COutputLogger.h.

Referenced by mrpt::system::COutputLogger::TMsg::dumpToConsole().

◆ logging_levels_to_names

std::string COutputLogger::logging_levels_to_names
staticinherited
Initial value:
=
{
"DEBUG",
"INFO ",
"WARN ",
"ERROR"
}

Map from VerbosityLevels to their corresponding names.

Handy for printing the current message VerbosityLevel along with the actual content

Definition at line 129 of file system/COutputLogger.h.

Referenced by mrpt::system::COutputLogger::TMsg::getAsString().

◆ m_history

std::deque<TMsg> mrpt::system::COutputLogger::m_history
mutableprivateinherited

Definition at line 312 of file system/COutputLogger.h.

◆ m_listCallbacks

std::deque<output_logger_callback_t> mrpt::system::COutputLogger::m_listCallbacks
privateinherited

Definition at line 314 of file system/COutputLogger.h.

◆ m_logger_name

std::string mrpt::system::COutputLogger::m_logger_name
privateinherited

Definition at line 310 of file system/COutputLogger.h.

◆ m_min_verbosity_level

VerbosityLevel mrpt::system::COutputLogger::m_min_verbosity_level
protectedinherited

Provided messages with VerbosityLevel smaller than this value shall be ignored.

Definition at line 252 of file system/COutputLogger.h.

Referenced by mrpt::system::COutputLogger::getMinLoggingLevel(), and mrpt::system::COutputLogger::isLoggingLevelVisible().

◆ m_serialNumber

std::string mrpt::hwdrivers::CRoboticHeadInterface::m_serialNumber
private

◆ m_usbConnection

mrpt::comms::CInterfaceFTDI mrpt::hwdrivers::CRoboticHeadInterface::m_usbConnection
private

Definition at line 51 of file CRoboticHeadInterface.h.

Referenced by Get3SoundBuffer(), GetGain(), GetSoundLocation(), and SetGain().

◆ msg

mrpt::serialization::CMessage mrpt::hwdrivers::CRoboticHeadInterface::msg
private

Definition at line 52 of file CRoboticHeadInterface.h.

Referenced by Get3SoundBuffer(), GetGain(), GetSoundLocation(), and SetGain().

mrpt::system::COutputLogger::logStr
void logStr(const VerbosityLevel level, const std::string &msg_str) const
Main method to add the specified message string to the logger.
Definition: COutputLogger.cpp:61
mrpt::system::CONCOL_GREEN
@ CONCOL_GREEN
Definition: os.h:179
mrpt::system::CONCOL_BLUE
@ CONCOL_BLUE
Definition: os.h:178
mrpt::system::CONCOL_RED
@ CONCOL_RED
Definition: os.h:180
mrpt::system::COutputLogger::logFmt
void logFmt(const VerbosityLevel level, const char *fmt,...) const MRPT_printf_format_check(3
Alternative logging method, which mimics the printf behavior.
Definition: COutputLogger.cpp:80
mrpt::format
std::string format(const char *fmt,...) MRPT_printf_format_check(1
A std::string version of C sprintf.
Definition: format.cpp:16
mrpt::system::CONCOL_NORMAL
@ CONCOL_NORMAL
Definition: os.h:177
in
GLuint in
Definition: glext.h:7274



Page generated by Doxygen 1.8.17 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at miƩ 12 jul 2023 10:03:34 CEST