cv::CommandLineParser Class Reference

designed for command line arguments parsing More...

#include "utility.hpp"

Public Member Functions
	CommandLineParser (int argc, const char *const argv[], const String &keys)
	CommandLineParser (const CommandLineParser &parser)
	~CommandLineParser ()
void	about (const String &message)
bool	check () const
template<typename T >
T	get (const String &name, bool space_delete=true) const
template<typename T >
T	get (int index, bool space_delete=true) const
String	getPathToApplication () const
bool	has (const String &name) const
CommandLineParser &	operator= (const CommandLineParser &parser)
void	printErrors () const
void	printMessage () const

Protected Member Functions
void	getByIndex (int index, bool space_delete, int type, void *dst) const
void	getByName (const String &name, bool space_delete, int type, void *dst) const

Protected Attributes
Impl *	impl

Detailed Description

designed for command line arguments parsing

The sample below demonstrates how to use CommandLineParser:

CommandLineParser parser(argc, argv, keys);
parser.about("Application name v1.0.0");

if (parser.has("help"))
{
    parser.printMessage();
    return 0;
}

int N = parser.get<int>("N");
double fps = parser.get<double>("fps");
String path = parser.get<String>("path");

use_time_stamp = parser.has("timestamp");

String img1 = parser.get<String>(0);
String img2 = parser.get<String>(1);

int repeat = parser.get<int>(2);

if (!parser.check())
{
    parser.printErrors();
    return 0;
}

Syntax:

const String keys =
    "{help h usage ? |      | print this message   }"
    "{@image1        |      | image1 for compare   }"
    "{@image2        |      | image2 for compare   }"
    "{@repeat        |1     | number               }"
    "{path           |.     | path to file         }"
    "{fps            | -1.0 | fps for output video }"
    "{N count        |100   | count of objects     }"
    "{ts timestamp   |      | use time stamp       }"
    ;

Use:

# ./app -N=200 1.png 2.jpg 19 -ts

# ./app -fps=aaa
ERRORS:
Exception: can not convert: [aaa] to [double]

Examples:

demhist.cpp, distrans.cpp, and edge.cpp.

Constructor & Destructor Documentation

cv::CommandLineParser::CommandLineParser	(	int	argc,
		const char *const	argv[],
		const String &	keys
	)

cv::CommandLineParser::CommandLineParser

(

const CommandLineParser &

parser

)

cv::CommandLineParser::~CommandLineParser

(

)

Member Function Documentation

void cv::CommandLineParser::about

(

const String &

message

)

bool cv::CommandLineParser::check

(

)

const

template<typename T >

T cv::CommandLineParser::get ( const String &  name, bool  space_delete = true  ) const

inline

template<typename T >

T cv::CommandLineParser::get ( int  index, bool  space_delete = true  ) const

inline

void cv::CommandLineParser::getByIndex ( int  index, bool  space_delete, int  type, void *  dst  ) const

protected

void cv::CommandLineParser::getByName ( const String &  name, bool  space_delete, int  type, void *  dst  ) const

protected

String cv::CommandLineParser::getPathToApplication

(

)

const

bool cv::CommandLineParser::has

(

const String &

name

)

const

CommandLineParser& cv::CommandLineParser::operator=

(

const CommandLineParser &

parser

)

void cv::CommandLineParser::printErrors

(

)

const

void cv::CommandLineParser::printMessage

(

)

const

Member Data Documentation

Impl* cv::CommandLineParser::impl

protected

---

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

• core/include/opencv2/core/utility.hpp