b2api
B2000++ API Reference Manual, VERSION 4.6
 
Loading...
Searching...
No Matches
b2000::cli Class Reference

Class to describe the command line interface for b2000. More...

#include "b2cli.H"

Collaboration diagram for b2000::cli:

Public Member Functions

void PrintVersion () const
 Print the version number of the running B2000++ to the out stream.
 
void ProcessCmdOpts (cmdline::CmdLine &cline)
 
void Abort (int use_err=1)
 Abort the program execution with an error code use_err.
 

Detailed Description

Class to describe the command line interface for b2000.

Gathers the command line options of the main b2000 program and provides helping functions for the interaction with the user. By default the class uses std::cout for output and std::cerr for error messages. The b2000::Communicator comm is needed to ensure proper output in parallel executions.

Member Function Documentation

◆ ProcessCmdOpts()

void b2000::cli::ProcessCmdOpts ( cmdline::CmdLine cline)

Add the main B2000++ options to the given command line parser and process them.

Options and arguments of this object are appended to the given cmdline, parsed and acted upon.

Parameters
clineis a reference to a b2000::cmdline:CmdLine object, to which the options and arguments are to be appended.

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