MRPT  1.9.9
mrpt::nav::CRobot2NavInterfaceForSimulator_Holo Class Referenceabstract

Detailed Description

CRobot2NavInterface implemented for a simulator object based on mrpt::kinematics::CVehicleSimul_Holo.

Only senseObstacles() remains virtual for the user to implement it.

See also
CReactiveNavigationSystem, CAbstractNavigator, mrpt::kinematics::CVehicleSimulVirtualBase

Definition at line 25 of file CRobot2NavInterfaceForSimulator.h.

#include <mrpt/nav/reactive/CRobot2NavInterfaceForSimulator.h>

Inheritance diagram for mrpt::nav::CRobot2NavInterfaceForSimulator_Holo:
Inheritance graph

Public Member Functions

 CRobot2NavInterfaceForSimulator_Holo (mrpt::kinematics::CVehicleSimul_Holo &simul)
 
bool getCurrentPoseAndSpeeds (mrpt::math::TPose2D &curPose, mrpt::math::TTwist2D &curVel, mrpt::system::TTimeStamp &timestamp, mrpt::math::TPose2D &curOdometry, std::string &frame_id) override
 Get the current pose and velocity of the robot. More...
 
virtual bool changeSpeeds (const mrpt::kinematics::CVehicleVelCmd &vel_cmd) override
 Sends a velocity command to the robot. More...
 
bool stop (bool isEmergencyStop) override
 Stop the robot right now. More...
 
mrpt::kinematics::CVehicleVelCmd::Ptr getEmergencyStopCmd () override
 Gets the emergency stop command for the current robot. More...
 
mrpt::kinematics::CVehicleVelCmd::Ptr getStopCmd () override
 Gets the emergency stop command for the current robot. More...
 
mrpt::kinematics::CVehicleVelCmd::Ptr getAlignCmd (const double relative_heading_radians) override
 Gets a motion command to make the robot to align with a given relative heading, without translating. More...
 
double getNavigationTime () override
 See CRobot2NavInterface::getNavigationTime(). More...
 
void resetNavigationTimer () override
 See CRobot2NavInterface::resetNavigationTimer() More...
 
virtual bool changeSpeedsNOP ()
 Just like changeSpeeds(), but will be called when the last velocity command is still the preferred solution, so there is no need to change that past command. More...
 
virtual bool startWatchdog (float T_ms)
 Start the watchdog timer of the robot platform, if any, for maximum expected delay between consecutive calls to changeSpeeds(). More...
 
virtual bool stopWatchdog ()
 Stop the watchdog timer. More...
 
virtual bool senseObstacles (mrpt::maps::CSimplePointsMap &obstacles, mrpt::system::TTimeStamp &timestamp)=0
 Return the current set of obstacle points, as seen from the local coordinate frame of the robot. More...
 
Navigation event callbacks
virtual void sendNavigationStartEvent ()
 Callback: Start of navigation command. More...
 
virtual void sendNavigationEndEvent ()
 Callback: End of navigation command (reach of single goal, or final waypoint of waypoint list) More...
 
virtual void sendWaypointReachedEvent (int waypoint_index, bool reached_nSkipped)
 Callback: Reached an intermediary waypoint in waypoint list navigation. More...
 
virtual void sendNewWaypointTargetEvent (int waypoint_index)
 Callback: Heading towards a new intermediary/final waypoint in waypoint list navigation. More...
 
virtual void sendNavigationEndDueToErrorEvent ()
 Callback: Error asking sensory data from robot or sending motor commands. More...
 
virtual void sendWaySeemsBlockedEvent ()
 Callback: No progression made towards target for a predefined period of time. More...
 
virtual void sendApparentCollisionEvent ()
 Callback: Apparent collision event (i.e. More...
 
virtual void sendCannotGetCloserToBlockedTargetEvent ()
 Callback: Target seems to be blocked by an obstacle. More...
 

Static Public Member Functions

static std::array< mrpt::system::TConsoleColor, NUMBER_OF_VERBOSITY_LEVELS > & logging_levels_to_colors ()
 Map from VerbosityLevels to their corresponding mrpt::system::TConsoleColor. More...
 
static std::array< std::string, NUMBER_OF_VERBOSITY_LEVELS > & logging_levels_to_names ()
 Map from VerbosityLevels to their corresponding names. More...
 

Protected Attributes

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

Private Attributes

mrpt::kinematics::CVehicleSimul_Holom_simul
 
double m_simul_time_start
 for getNavigationTime More...
 

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

◆ CRobot2NavInterfaceForSimulator_Holo()

mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::CRobot2NavInterfaceForSimulator_Holo ( mrpt::kinematics::CVehicleSimul_Holo simul)
inline

Definition at line 33 of file CRobot2NavInterfaceForSimulator.h.

Member Function Documentation

◆ changeSpeeds()

virtual bool mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::changeSpeeds ( const mrpt::kinematics::CVehicleVelCmd vel_cmd)
inlineoverridevirtual

Sends a velocity command to the robot.

The number components in each command depends on children classes of mrpt::kinematics::CVehicleVelCmd. One robot may accept one or more different CVehicleVelCmd classes. This method resets the watchdog timer (that may be or may be not implemented in a particular robotic platform) started with startWatchdog()

Returns
false on any error.
See also
startWatchdog

Implements mrpt::nav::CRobot2NavInterface.

Definition at line 51 of file CRobot2NavInterfaceForSimulator.h.

References m_simul, and mrpt::kinematics::CVehicleSimul_Holo::sendVelCmd().

◆ changeSpeedsNOP()

bool CRobot2NavInterface::changeSpeedsNOP ( )
virtualinherited

Just like changeSpeeds(), but will be called when the last velocity command is still the preferred solution, so there is no need to change that past command.

The unique effect of this callback would be resetting the watchdog timer.

Returns
false on any error.
See also
changeSpeeds(), startWatchdog()

Definition at line 21 of file CRobot2NavInterface.cpp.

References MRPT_LOG_THROTTLE_INFO.

Referenced by mrpt::nav::CAbstractNavigator::changeSpeedsNOP().

◆ dumpLogToConsole()

void COutputLogger::dumpLogToConsole ( ) const
inherited

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

See also
writeToFile

Definition at line 190 of file COutputLogger.cpp.

◆ getAlignCmd()

mrpt::kinematics::CVehicleVelCmd::Ptr mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::getAlignCmd ( const double  relative_heading_radians)
inlineoverridevirtual

Gets a motion command to make the robot to align with a given relative heading, without translating.

Only for circular robots that can rotate in place; otherwise, return an empty smart pointer to indicate that the operation is not possible (this is what the default implementation does).

Reimplemented from mrpt::nav::CRobot2NavInterface.

Definition at line 78 of file CRobot2NavInterfaceForSimulator.h.

References mrpt::DEG2RAD(), and mrpt::signWithZero().

◆ getCurrentPoseAndSpeeds()

bool mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::getCurrentPoseAndSpeeds ( mrpt::math::TPose2D curPose,
mrpt::math::TTwist2D curVelGlobal,
mrpt::system::TTimeStamp timestamp,
mrpt::math::TPose2D curOdometry,
std::string frame_id 
)
inlineoverridevirtual

Get the current pose and velocity of the robot.

The implementation should not take too much time to return, so if it might take more than ~10ms to ask the robot for the instantaneous data, it may be good enough to return the latest values from a cache which is updated in a parallel thread.

Returns
false on any error retrieving these values from the robot.

Implements mrpt::nav::CRobot2NavInterface.

Definition at line 39 of file CRobot2NavInterfaceForSimulator.h.

References mrpt::kinematics::CVehicleSimulVirtualBase::getCurrentGTPose(), mrpt::kinematics::CVehicleSimulVirtualBase::getCurrentGTVel(), mrpt::kinematics::CVehicleSimulVirtualBase::getCurrentOdometricPose(), m_simul, and mrpt::system::now().

◆ getEmergencyStopCmd()

mrpt::kinematics::CVehicleVelCmd::Ptr mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::getEmergencyStopCmd ( )
inlineoverridevirtual

Gets the emergency stop command for the current robot.

Returns
the emergency stop command

Implements mrpt::nav::CRobot2NavInterface.

Definition at line 66 of file CRobot2NavInterfaceForSimulator.h.

◆ getLogAsString() [1/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 154 of file COutputLogger.cpp.

◆ getLogAsString() [2/2]

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

Get the history of COutputLogger instance in a string representation.

Definition at line 159 of file COutputLogger.cpp.

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

◆ getLoggerLastMsg() [1/2]

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

Return the last Tmsg instance registered in the logger history.

Definition at line 195 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 201 of file COutputLogger.cpp.

◆ getLoggerName()

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

Return the name of the COutputLogger instance.

See also
setLoggerName

Definition at line 143 of file COutputLogger.cpp.

◆ getMinLoggingLevel()

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

◆ getNavigationTime()

double mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::getNavigationTime ( )
inlineoverridevirtual

See CRobot2NavInterface::getNavigationTime().

In this class, simulation time is returned instead of wall-clock time.

Reimplemented from mrpt::nav::CRobot2NavInterface.

Definition at line 93 of file CRobot2NavInterfaceForSimulator.h.

References mrpt::kinematics::CVehicleSimulVirtualBase::getTime(), m_simul, and m_simul_time_start.

◆ getStopCmd()

mrpt::kinematics::CVehicleVelCmd::Ptr mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::getStopCmd ( )
inlineoverridevirtual

Gets the emergency stop command for the current robot.

Returns
the emergency stop command

Implements mrpt::nav::CRobot2NavInterface.

Definition at line 72 of file CRobot2NavInterfaceForSimulator.h.

◆ isLoggingLevelVisible()

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

◆ 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 131 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 290 of file COutputLogger.cpp.

References getAddress(), and mrpt::system::COutputLogger::m_listCallbacks.

◆ logFmt()

◆ loggerReset()

void COutputLogger::loggerReset ( )
inherited

Reset the contents of the logger instance.

Called upon construction.

Definition at line 206 of file COutputLogger.cpp.

References mrpt::system::LVL_INFO.

◆ logging_levels_to_colors()

std::array< mrpt::system::TConsoleColor, NUMBER_OF_VERBOSITY_LEVELS > & COutputLogger::logging_levels_to_colors ( )
staticinherited

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

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

Definition at line 47 of file COutputLogger.cpp.

References logging_levels_to_colors.

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

◆ logging_levels_to_names()

std::array< std::string, NUMBER_OF_VERBOSITY_LEVELS > & COutputLogger::logging_levels_to_names ( )
staticinherited

Map from VerbosityLevels to their corresponding names.

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

Definition at line 60 of file COutputLogger.cpp.

References logging_levels_to_names.

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

◆ logRegisterCallback()

void COutputLogger::logRegisterCallback ( output_logger_callback_t  userFunc)
inherited

Definition at line 277 of file COutputLogger.cpp.

References mrpt::system::COutputLogger::m_listCallbacks.

◆ logStr()

◆ resetNavigationTimer()

void mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::resetNavigationTimer ( )
inlineoverridevirtual

◆ sendApparentCollisionEvent()

void CRobot2NavInterface::sendApparentCollisionEvent ( )
virtualinherited

Callback: Apparent collision event (i.e.

there is at least one obstacle point inside the robot shape)

Definition at line 102 of file CRobot2NavInterface.cpp.

References MRPT_LOG_THROTTLE_INFO.

Referenced by mrpt::nav::CAbstractPTGBasedReactive::performNavigationStep().

Here is the caller graph for this function:

◆ sendCannotGetCloserToBlockedTargetEvent()

void CRobot2NavInterface::sendCannotGetCloserToBlockedTargetEvent ( )
virtualinherited

Callback: Target seems to be blocked by an obstacle.

Definition at line 110 of file CRobot2NavInterface.cpp.

References MRPT_LOG_THROTTLE_INFO.

◆ sendNavigationEndDueToErrorEvent()

void CRobot2NavInterface::sendNavigationEndDueToErrorEvent ( )
virtualinherited

Callback: Error asking sensory data from robot or sending motor commands.

Definition at line 86 of file CRobot2NavInterface.cpp.

References MRPT_LOG_THROTTLE_INFO.

Referenced by mrpt::nav::CAbstractNavigator::navigationStep().

Here is the caller graph for this function:

◆ sendNavigationEndEvent()

void CRobot2NavInterface::sendNavigationEndEvent ( )
virtualinherited

Callback: End of navigation command (reach of single goal, or final waypoint of waypoint list)

Definition at line 63 of file CRobot2NavInterface.cpp.

References MRPT_LOG_INFO.

Referenced by mrpt::nav::CAbstractNavigator::performNavigationStepNavigating().

Here is the caller graph for this function:

◆ sendNavigationStartEvent()

void CRobot2NavInterface::sendNavigationStartEvent ( )
virtualinherited

Callback: Start of navigation command.

Definition at line 56 of file CRobot2NavInterface.cpp.

References MRPT_LOG_INFO.

Referenced by mrpt::nav::CAbstractNavigator::performNavigationStepNavigating().

Here is the caller graph for this function:

◆ sendNewWaypointTargetEvent()

void CRobot2NavInterface::sendNewWaypointTargetEvent ( int  waypoint_index)
virtualinherited

Callback: Heading towards a new intermediary/final waypoint in waypoint list navigation.

Definition at line 79 of file CRobot2NavInterface.cpp.

References MRPT_LOG_INFO_STREAM.

Referenced by mrpt::nav::CWaypointsNavigator::waypoints_navigationStep().

Here is the caller graph for this function:

◆ sendWaypointReachedEvent()

void CRobot2NavInterface::sendWaypointReachedEvent ( int  waypoint_index,
bool  reached_nSkipped 
)
virtualinherited

Callback: Reached an intermediary waypoint in waypoint list navigation.

reached_nSkipped will be true if the waypoint was physically reached; false if it was actually "skipped".

Definition at line 70 of file CRobot2NavInterface.cpp.

References MRPT_LOG_INFO_STREAM.

Referenced by mrpt::nav::CWaypointsNavigator::waypoints_navigationStep().

Here is the caller graph for this function:

◆ sendWaySeemsBlockedEvent()

void CRobot2NavInterface::sendWaySeemsBlockedEvent ( )
virtualinherited

Callback: No progression made towards target for a predefined period of time.

Definition at line 94 of file CRobot2NavInterface.cpp.

References MRPT_LOG_THROTTLE_INFO.

Referenced by mrpt::nav::CAbstractNavigator::performNavigationStepNavigating().

Here is the caller graph for this function:

◆ senseObstacles()

virtual bool mrpt::nav::CRobot2NavInterface::senseObstacles ( mrpt::maps::CSimplePointsMap obstacles,
mrpt::system::TTimeStamp timestamp 
)
pure virtualinherited

Return the current set of obstacle points, as seen from the local coordinate frame of the robot.

Returns
false on any error.
Parameters
[out]obstaclesA representation of obstacles in robot-centric coordinates.
[out]timestampThe timestamp for the read obstacles. Use mrpt::system::now() unless you have something more accurate.

Referenced by mrpt::nav::CReactiveNavigationSystem::implementSenseObstacles(), and mrpt::nav::CReactiveNavigationSystem3D::implementSenseObstacles().

◆ setLoggerName()

◆ 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 144 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()

◆ startWatchdog()

bool CRobot2NavInterface::startWatchdog ( float  T_ms)
virtualinherited

Start the watchdog timer of the robot platform, if any, for maximum expected delay between consecutive calls to changeSpeeds().

Parameters
T_msPeriod, in ms.
Returns
false on any error.

Definition at line 37 of file CRobot2NavInterface.cpp.

References MRPT_LOG_INFO_FMT.

Referenced by mrpt::nav::CAbstractNavigator::internal_onStartNewNavigation().

Here is the caller graph for this function:

◆ stop()

bool mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::stop ( bool  isEmergencyStop)
inlineoverridevirtual

Stop the robot right now.

Parameters
[in]isEmergencyStoptrue if stop is due to some unexpected error. false if "stop" happens as part of a normal operation (e.g. target reached).
Returns
false on any error.

Implements mrpt::nav::CRobot2NavInterface.

Definition at line 58 of file CRobot2NavInterfaceForSimulator.h.

References m_simul, and mrpt::kinematics::CVehicleSimul_Holo::sendVelRampCmd().

◆ stopWatchdog()

bool CRobot2NavInterface::stopWatchdog ( )
virtualinherited

Stop the watchdog timer.

Returns
false on any error.
See also
startWatchdog

Definition at line 47 of file CRobot2NavInterface.cpp.

References MRPT_LOG_INFO.

Referenced by mrpt::nav::CAbstractNavigator::navigationStep().

Here is the caller graph for this function:

◆ 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 165 of file COutputLogger.cpp.

References ASSERTMSG_, and mrpt::format().

Member Data Documentation

◆ 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.

◆ 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_simul

mrpt::kinematics::CVehicleSimul_Holo& mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::m_simul
private

◆ m_simul_time_start

double mrpt::nav::CRobot2NavInterfaceForSimulator_Holo::m_simul_time_start
private

for getNavigationTime

Definition at line 30 of file CRobot2NavInterfaceForSimulator.h.

Referenced by getNavigationTime(), and resetNavigationTimer().




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: 7d5e6d718 Fri Aug 24 01:51:28 2018 +0200 at lun nov 2 08:35:50 CET 2020