util::cli::binder::cmd_option_bind_base Class Reference

#include <cmd_option_list.h>

Inheritance diagram for util::cli::binder::cmd_option_bind_base:

Collaboration diagram for util::cli::binder::cmd_option_bind_base:

Data Structures
struct	help_msg_t

Public Types
typedef callback_param	param_type

Public Member Functions
virtual void	operator() (callback_param arg)=0
virtual std::string	get_help_msg (const char *prefix_data="") const
virtual std::shared_ptr< cmd_option_bind_base >	set_help_msg (const char *help_msg)
virtual std::shared_ptr< cmd_option_bind_base >	add_help_msg (const char *help_msg)

Protected Types
typedef std::vector< help_msg_t >	help_list_t

Protected Member Functions
virtual	~cmd_option_bind_base ()

Static Protected Member Functions
static bool	sort_by_all_cmds (const help_msg_t &l, const help_msg_t &r)

Protected Attributes
std::string	help_msg_

Static Protected Attributes
static const char *	ROOT_NODE_CMD = "@Root"

Detailed Description

Definition at line 32 of file cmd_option_list.h.

Member Typedef Documentation

help_list_t

typedef std::vector<help_msg_t> util::cli::binder::cmd_option_bind_base::help_list_t

protected

Definition at line 41 of file cmd_option_list.h.

param_type

typedef callback_param util::cli::binder::cmd_option_bind_base::param_type

Definition at line 50 of file cmd_option_list.h.

Constructor & Destructor Documentation

~cmd_option_bind_base()

virtual util::cli::binder::cmd_option_bind_base::~cmd_option_bind_base ( )

inlineprotectedvirtual

Definition at line 44 of file cmd_option_list.h.

Member Function Documentation

add_help_msg()

virtual std::shared_ptr<cmd_option_bind_base> util::cli::binder::cmd_option_bind_base::add_help_msg ( const char *  help_msg )

inlinevirtual

Definition at line 64 of file cmd_option_list.h.

References help_msg_.

get_help_msg()

virtual std::string util::cli::binder::cmd_option_bind_base::get_help_msg ( const char *  prefix_data = "" ) const

inlinevirtual

Reimplemented in util::cli::cmd_option_bind< TCmdStr >.

Definition at line 55 of file cmd_option_list.h.

References help_msg_.

operator()()

virtual void util::cli::binder::cmd_option_bind_base::operator() ( callback_param  arg )

pure virtual

Implemented in util::cli::binder::cmd_option_bindt< _F, _PL >, and util::cli::cmd_option_bind< TCmdStr >.

set_help_msg()

virtual std::shared_ptr<cmd_option_bind_base> util::cli::binder::cmd_option_bind_base::set_help_msg ( const char *  help_msg )

inlinevirtual

Definition at line 58 of file cmd_option_list.h.

References help_msg_.

sort_by_all_cmds()

static bool util::cli::binder::cmd_option_bind_base::sort_by_all_cmds ( const help_msg_t &  l, const help_msg_t &  r  )

inlinestaticprotected

Definition at line 46 of file cmd_option_list.h.

References util::cli::binder::cmd_option_bind_base::help_msg_t::all_cmds.

Referenced by util::cli::cmd_option_bind< TCmdStr >::dump().

Field Documentation

help_msg_

std::string util::cli::binder::cmd_option_bind_base::help_msg_

protected

Definition at line 43 of file cmd_option_list.h.

Referenced by add_help_msg(), util::cli::cmd_option_bind< TCmdStr >::get_help_msg(), get_help_msg(), and set_help_msg().

ROOT_NODE_CMD

const char * util::cli::binder::cmd_option_bind_base::ROOT_NODE_CMD = "@Root"

staticprotected

Definition at line 34 of file cmd_option_list.h.

Referenced by util::cli::cmd_option_bind< TCmdStr >::run_cmd().

---

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

• /home/runner/work/libcopp/libcopp/test/cli/cmd_option_list.h
• /home/runner/work/libcopp/libcopp/test/cli/cmd_option_list.cpp