sese::ArgParser类 参考

命令行参数解析类 更多...

#include <ArgParser.h>

Public 类型
typedef std::unique_ptr< ArgParser >	Ptr

Public 成员函数
	ArgParser ()=default
bool	parse (int32_t argc, char **argv) noexcept
const std::map< std::string, std::string > &	getKeyValSet () const noexcept
const std::string &	getValueByKey (const std::string &key, const std::string &default_value) const noexcept
bool	exist (const std::string &key) const noexcept
const std::string &	getCurrentPath () const
const std::string &	getFileName () const
const std::string &	getFullPath () const

Private 属性
std::string	fullPath
std::string	currentPath
std::string	fileName
std::map< std::string, std::string >	keyValSet

详细描述

命令行参数解析类

成员类型定义说明

Ptr

typedef std::unique_ptr<ArgParser> sese::ArgParser::Ptr

构造及析构函数说明

ArgParser()

sese::ArgParser::ArgParser ( )

default

成员函数说明

exist()

bool sese::ArgParser::exist ( const std::string & key ) const

nodiscardnoexcept

根据参数名称判断当前参数是否存在，适用于一些单独的不需要指定值的开关

参数

key

参数名称

返回

该参数是否存在

getCurrentPath()

const std::string & sese::ArgParser::getCurrentPath ( ) const

inlinenodiscard

获取程序工作目录

返回

工作目录字符串，结尾不带目录分割符

引用了 currentPath.

getFileName()

const std::string & sese::ArgParser::getFileName ( ) const

inlinenodiscard

获取程序当前名称

返回

程序当前名称

引用了 fileName.

getFullPath()

const std::string & sese::ArgParser::getFullPath ( ) const

inlinenodiscard

获取程序当前的绝对路径

返回

程序路径

引用了 fullPath.

getKeyValSet()

const std::map< std::string, std::string > & sese::ArgParser::getKeyValSet ( ) const

nodiscardnoexcept

返回

返回整个参数 Map

引用了 keyValSet.

getValueByKey()

const std::string & sese::ArgParser::getValueByKey ( const std::string & key, const std::string & default_value ) const

nodiscardnoexcept

根据参数名称获取参数值

参数

key	参数名称
default_value	参数默认值

返回

返回参数值，参数不存在返回默认值

parse()

bool sese::ArgParser::parse ( int32_t argc, char ** argv )

noexcept

初始化解析器

参数

argc	参数个数
argv	实际参数

返回

解析是否成功

类成员变量说明

currentPath

std::string sese::ArgParser::currentPath

private

被这些函数引用 getCurrentPath().

fileName

std::string sese::ArgParser::fileName

private

被这些函数引用 getFileName().

fullPath

std::string sese::ArgParser::fullPath

private

被这些函数引用 getFullPath().

keyValSet

std::map<std::string, std::string> sese::ArgParser::keyValSet

private

被这些函数引用 getKeyValSet().

---

该类的文档由以下文件生成:

• sese/util/ArgParser.h
• sese/util/ArgParser.cpp