ArgParser Namespace Reference

Typedefs
using	ArgVal = std::optional<std::variant<int, double, std::string>>
using	Key = std::tuple<std::string, ArgType, std::string>
using	ParsedArgs = std::unordered_map<std::string, ArgVal>

Enumerations
enum class	ArgType { NoArg , Integer , Double , String }

Functions
template<typename T>
T	GetVal (const ArgVal &arg_val)
	Gets the value out of an ArgVal (std::optional<std::variant<int, double, std::string>>) object.
ParsedArgs	ParseArgs (const std::vector< Key > &keys, const int argc, char const *const *argv)
	Function to parse the command line arguments.
void	PrintHelp (const std::vector< Key > &cmd_list)
	Prints the command line options.

Typedef Documentation

ArgVal

using ArgParser::ArgVal = std::optional<std::variant<int, double, std::string>>

Key

using ArgParser::Key = std::tuple<std::string, ArgType, std::string>

ParsedArgs

using ArgParser::ParsedArgs = std::unordered_map<std::string, ArgVal>

Enumeration Type Documentation

ArgType

enum class ArgParser::ArgType

strong

Enumerator
NoArg
Integer
Double
String

Function Documentation

GetVal()

template<typename T>

T ArgParser::GetVal

(

const ArgVal &

arg_val

)

Gets the value out of an ArgVal (std::optional<std::variant<int, double, std::string>>) object.

Template Parameters

T	the type to return (must be int, double, or std::string)

Parameters

[in]

arg_val

the ArgVal object

Returns

the value in arg_val

ParseArgs()

ParsedArgs ArgParser::ParseArgs	(	const std::vector< Key > &	keys,
		const int	argc,
		char const *const *	argv )

Function to parse the command line arguments.

Parameters

[in]	keys	the list of possible command line arguments
[in]	argc	the number of command line arguments
[in]	argv	all the command line arguments

Returns

the parsed command line arguments

PrintHelp()

void ArgParser::PrintHelp

(

const std::vector< Key > &

cmd_list

)

Prints the command line options.

Parameters

[in]

cmd_list

the list of possible command line arguments