Struct opencv::core::CommandLineParser

pub struct CommandLineParser { /* private fields */ }

Designed for command line 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;
   }

Keys syntax

The keys parameter is a string containing several blocks, each one is enclosed in curly braces and describes one argument. Each argument contains three parts separated by the | symbol:

-# argument names is a space-separated list of option synonyms (to mark argument as positional, prefix it with the @ symbol) -# default value will be used if the argument was not provided (can be empty) -# help message (can be empty)

For example:

   const String keys =
       "{help h usage ? |      | print this message   }"
       "{@image1        |      | image1 for compare   }"
       "{@image2        |<none>| 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       }"
       ;
}

Note that there are no default values for help and timestamp so we can check their presence using the has() method. Arguments with default values are considered to be always present. Use the get() method in these cases to check their actual value instead.

String keys like get<String>("@image1") return the empty string "" by default - even with an empty default value. Use the special <none> default value to enforce that the returned string must not be empty. (like in get<String>("@image2"))

Usage

For the described keys:

   # Good call (3 positional parameters: image1, image2 and repeat; N is 200, ts is true)
   $ ./app -N=200 1.png 2.jpg 19 -ts
 
   # Bad call
   $ ./app -fps=aaa
   ERRORS:
   Parameter "fps": can not convert: [aaa] to [double]

Implementations

impl CommandLineParser

pub fn new(argc: i32, argv: &[&str], keys: &str) -> Result<CommandLineParser>

Constructor

Initializes command line parser object

Parameters

• argc: number of command line arguments (from main())
• argv: array of command line arguments (from main())
• keys: string describing acceptable command line parameters (see class description for syntax)

pub fn copy( parser: &impl CommandLineParserTraitConst ) -> Result<CommandLineParser>

Copy constructor

Trait Implementations

impl Boxed for CommandLineParser

unsafe fn from_raw( ptr: <CommandLineParser as OpenCVFromExtern>::ExternReceive ) -> Self

Wrap the specified raw pointer

fn into_raw( self ) -> <CommandLineParser as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <CommandLineParser as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self ) -> <CommandLineParser as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl CommandLineParserTrait for CommandLineParser

fn as_raw_mut_CommandLineParser(&mut self) -> *mut c_void

fn set(&mut self, parser: &impl CommandLineParserTraitConst) -> Result<()>

Assignment operator

fn about(&mut self, message: &str) -> Result<()>

Set the about message

impl CommandLineParserTraitConst for CommandLineParser

fn as_raw_CommandLineParser(&self) -> *const c_void

fn get_path_to_application(&self) -> Result<String>

Returns application path

fn get_bool(&self, name: &str, space_delete: bool) -> Result<bool>

Access arguments by name

fn get_bool_def(&self, name: &str) -> Result<bool>

Access arguments by name

fn get_i32(&self, name: &str, space_delete: bool) -> Result<i32>

Access arguments by name

fn get_i32_def(&self, name: &str) -> Result<i32>

Access arguments by name

fn get_f64(&self, name: &str, space_delete: bool) -> Result<f64>

Access arguments by name

fn get_f64_def(&self, name: &str) -> Result<f64>

Access arguments by name

fn get_str(&self, name: &str, space_delete: bool) -> Result<String>

Access arguments by name

fn get_str_def(&self, name: &str) -> Result<String>

Access arguments by name

fn get_u64(&self, name: &str, space_delete: bool) -> Result<u64>

Access arguments by name

fn get_u64_def(&self, name: &str) -> Result<u64>

Access arguments by name

fn get_bool_idx(&self, index: i32, space_delete: bool) -> Result<bool>

Access positional arguments by index

fn get_bool_idx_def(&self, index: i32) -> Result<bool>

Access positional arguments by index

fn get_i32_idx(&self, index: i32, space_delete: bool) -> Result<i32>

Access positional arguments by index

fn get_i32_idx_def(&self, index: i32) -> Result<i32>

Access positional arguments by index

fn get_f64_idx(&self, index: i32, space_delete: bool) -> Result<f64>

Access positional arguments by index

fn get_f64_idx_def(&self, index: i32) -> Result<f64>

Access positional arguments by index

fn get_str_idx(&self, index: i32, space_delete: bool) -> Result<String>

Access positional arguments by index

fn get_str_idx_def(&self, index: i32) -> Result<String>

Access positional arguments by index

fn get_u64_idx(&self, index: i32, space_delete: bool) -> Result<u64>

Access positional arguments by index

fn get_u64_idx_def(&self, index: i32) -> Result<u64>

Access positional arguments by index

fn has(&self, name: &str) -> Result<bool>

Check if field was provided in the command line

fn check(&self) -> Result<bool>

Check for parsing errors

fn print_message(&self) -> Result<()>

Print help message

fn print_errors(&self) -> Result<()>

Print list of errors occurred

impl Debug for CommandLineParser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for CommandLineParser

fn drop(&mut self)

Executes the destructor for this type.

impl Send for CommandLineParser