R3BROOT
R3B analysis software
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
R3B::Neuland::CLIAbstract Class Referenceabstract

#include <R3BNeulandCLIAbstract.h>

Public Member Functions

 CLIAbstract ()=default
 Default constructor.
 
virtual ~CLIAbstract ()=default
 
 CLIAbstract (const CLIAbstract &)=default
 
 CLIAbstract (CLIAbstract &&)=default
 
auto operator= (const CLIAbstract &) -> CLIAbstract &=default
 
auto operator= (CLIAbstract &&) -> CLIAbstract &=default
 
virtual void init ()=0
 Initialization of a CLI program.
 
virtual void run ()=0
 Run the CLI program.
 
virtual void setup_options (CLI::App &program_options)=0
 Setup the CLI options given to the program.
 
virtual void post_parse ()
 Action done after the option parsing.
 
virtual auto has_print_default_options () const -> bool
 Check the flag whether the default options should be printed in JSON strings.
 
virtual auto has_dump () const -> bool
 Check whether the options should be dump to a JSON file.
 
virtual void print_options ()
 
virtual void dump_options ()
 
virtual void set_rank_num (int val)
 
virtual void set_num_of_procs (int val)
 
void set_fail (bool is_failed)
 
auto has_failed () const -> bool
 
auto has_inited () const -> bool
 

Protected Member Functions

void set_inited (bool is_inited)
 

Private Attributes

bool is_failed_ = false
 
bool is_inited_ = false
 

Detailed Description

Definition at line 7 of file R3BNeulandCLIAbstract.h.

Constructor & Destructor Documentation

◆ CLIAbstract() [1/3]

R3B::Neuland::CLIAbstract::CLIAbstract ( )
default

◆ ~CLIAbstract()

virtual R3B::Neuland::CLIAbstract::~CLIAbstract ( )
virtualdefault

◆ CLIAbstract() [2/3]

R3B::Neuland::CLIAbstract::CLIAbstract ( const CLIAbstract & )
default

◆ CLIAbstract() [3/3]

R3B::Neuland::CLIAbstract::CLIAbstract ( CLIAbstract && )
default

Member Function Documentation

◆ dump_options()

virtual void R3B::Neuland::CLIAbstract::dump_options ( )
inlinevirtual

Reimplemented in R3B::Neuland::CLIApplication.

Definition at line 69 of file R3BNeulandCLIAbstract.h.

◆ has_dump()

virtual auto R3B::Neuland::CLIAbstract::has_dump ( ) const -> bool
inlinenodiscardvirtual

This metehod is only useful when if the dynamic type of the object is derived from R3B::Neuland::CLIApplication

Returns
Flag value

Reimplemented in R3B::Neuland::CLIApplication.

Definition at line 66 of file R3BNeulandCLIAbstract.h.

◆ has_failed()

auto R3B::Neuland::CLIAbstract::has_failed ( ) const -> bool
inlinenodiscard

Definition at line 77 of file R3BNeulandCLIAbstract.h.

◆ has_inited()

auto R3B::Neuland::CLIAbstract::has_inited ( ) const -> bool
inlinenodiscard

Definition at line 78 of file R3BNeulandCLIAbstract.h.

◆ has_print_default_options()

virtual auto R3B::Neuland::CLIAbstract::has_print_default_options ( ) const -> bool
inlinenodiscardvirtual

This metehod is only useful when if the dynamic type of the object is derived from R3B::Neuland::CLIApplication

Returns
Flag of printing JSON string.
See also
ref

Reimplemented in R3B::Neuland::CLIApplication.

Definition at line 57 of file R3BNeulandCLIAbstract.h.

◆ init()

virtual void R3B::Neuland::CLIAbstract::init ( )
pure virtual

The initialization process must be done before calling the run method. Setters such as set_rank_num should be called before the initialization. detailed description

Implemented in R3B::Neuland::CLIApplication.

◆ operator=() [1/2]

auto R3B::Neuland::CLIAbstract::operator= ( CLIAbstract && ) -> CLIAbstract &=default
default

◆ operator=() [2/2]

auto R3B::Neuland::CLIAbstract::operator= ( const CLIAbstract & ) -> CLIAbstract &=default
default

◆ post_parse()

virtual void R3B::Neuland::CLIAbstract::post_parse ( )
inlinevirtual

Thus this method should be called immediately after calling CLI11_PARSE.

Reimplemented in R3B::Neuland::CLIApplication.

Definition at line 47 of file R3BNeulandCLIAbstract.h.

◆ print_options()

virtual void R3B::Neuland::CLIAbstract::print_options ( )
inlinevirtual

Reimplemented in R3B::Neuland::CLIApplication.

Definition at line 68 of file R3BNeulandCLIAbstract.h.

◆ run()

virtual void R3B::Neuland::CLIAbstract::run ( )
pure virtual

Implemented in R3B::Neuland::CLIApplication.

◆ set_fail()

void R3B::Neuland::CLIAbstract::set_fail ( bool is_failed)
inline

Definition at line 74 of file R3BNeulandCLIAbstract.h.

◆ set_inited()

void R3B::Neuland::CLIAbstract::set_inited ( bool is_inited)
inlineprotected

Definition at line 81 of file R3BNeulandCLIAbstract.h.

◆ set_num_of_procs()

virtual void R3B::Neuland::CLIAbstract::set_num_of_procs ( int val)
inlinevirtual

Reimplemented in R3B::Neuland::CLIApplication.

Definition at line 71 of file R3BNeulandCLIAbstract.h.

◆ set_rank_num()

virtual void R3B::Neuland::CLIAbstract::set_rank_num ( int val)
inlinevirtual

Reimplemented in R3B::Neuland::CLIApplication.

Definition at line 70 of file R3BNeulandCLIAbstract.h.

◆ setup_options()

virtual void R3B::Neuland::CLIAbstract::setup_options ( CLI::App & program_options)
pure virtual
Parameters
program_optionsOptions fed to the program.

Implemented in R3B::Neuland::CLIApplication.

Member Data Documentation

◆ is_failed_

bool R3B::Neuland::CLIAbstract::is_failed_ = false
private

Definition at line 84 of file R3BNeulandCLIAbstract.h.

◆ is_inited_

bool R3B::Neuland::CLIAbstract::is_inited_ = false
private

Definition at line 85 of file R3BNeulandCLIAbstract.h.

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