Goby3  3.1.4
2024.02.22
goby::middleware::ToolHelper Class Reference

#include <goby/middleware/application/tool.h>

Public Member Functions

 ToolHelper (const std::string &name, const goby::middleware::protobuf::AppConfig::Tool &tool_cfg, const google::protobuf::EnumDescriptor *action_enum_desc)
 
template<typename Action >
bool perform_action (Action action)
 
bool help (int *action_for_help)
 
template<typename App , typename Configurator = middleware::ProtobufConfigurator<typename App::ConfigType>>
void run_subtool ()
 
template<typename App , typename Configurator = middleware::ProtobufConfigurator<typename App::ConfigType>>
void help (int action_for_help)
 

Detailed Description

Definition at line 38 of file tool.h.

Constructor & Destructor Documentation

◆ ToolHelper()

goby::middleware::ToolHelper::ToolHelper ( const std::string &  name,
const goby::middleware::protobuf::AppConfig::Tool tool_cfg,
const google::protobuf::EnumDescriptor *  action_enum_desc 
)
inline

Definition at line 41 of file tool.h.

Member Function Documentation

◆ help() [1/2]

bool goby::middleware::ToolHelper::help ( int action_for_help)

◆ help() [2/2]

template<typename App , typename Configurator >
void goby::middleware::ToolHelper::help ( int  action_for_help)

Definition at line 140 of file tool.h.

◆ perform_action()

template<typename Action >
bool goby::middleware::ToolHelper::perform_action ( Action  action)

Definition at line 100 of file tool.h.

◆ run_subtool()

template<typename App , typename Configurator >
void goby::middleware::ToolHelper::run_subtool

Definition at line 131 of file tool.h.


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