The ROme OpTimistic Simulator  3.0.0
A General-Purpose Multithreaded Parallel/Distributed Simulation Platform
ap_option Struct Reference

A single parsable command line option. More...

#include <arg_parse.h>

Data Fields

const char * name
 The long option name.
 
int key
 The key passed to the parsing function when encountering this option. More...
 
const char * arg
 The argument name for this option, shown in the --usage text. More...
 
const char * doc
 The documentation of this option, shown in the --help text. More...
 

Detailed Description

A single parsable command line option.

Definition at line 14 of file arg_parse.h.

Field Documentation

◆ arg

const char * ap_option::arg

The argument name for this option, shown in the --usage text.

If not NULL, the argument is mandatory, else it is disallowed

Definition at line 22 of file arg_parse.h.

◆ doc

const char * ap_option::doc

The documentation of this option, shown in the --help text.

This field can be set to NULL

Definition at line 25 of file arg_parse.h.

◆ key

int ap_option::key

The key passed to the parsing function when encountering this option.

This value must be strictly lower than 2^14

Definition at line 19 of file arg_parse.h.


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