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

#include <R3BNeulandApp.h>

Classes

struct  Options
 

Public Member Functions

 Application (std::string_view name, std::unique_ptr< FairRun > run, std::reference_wrapper< Options > option)
 
 Application (const Application &)=delete
 
 Application (Application &&)=delete
 
auto operator= (const Application &) -> Application &=delete
 
auto operator= (Application &&) -> Application &=delete
 
virtual ~Application ()
 
void setup_options (CLI::App &program_options)
 
template<typename CLIAPP, typename OptionType>
void setup_common_options (CLIAPP &program_options, OptionType &options)
 
template<typename OptionType>
void print_json_options (const OptionType &options)
 
template<typename OptionType>
void dump_json_options (const OptionType &options, const std::string &filename)
 
void set_log_level (std::string_view log_level)
 
void set_run_id (int run_id)
 
void set_output_filename (std::string_view output_filename)
 
void set_inputpar_filename (std::string_view inputpar_filename)
 
void set_second_inputpar_filename (std::string_view inputpar_filename)
 
void set_outputpar_filename (std::string_view outputpar_filename)
 
void set_event_num (int val)
 
void set_input_filename (const std::vector< std::string > &input_filename)
 
void set_tree_input_filename (const std::vector< std::string > &input_filename)
 
void set_num_of_procs (int val)
 
void set_rank_num (int val)
 
void set_fail (bool is_failed)
 
auto get_run () -> FairRun *
 
auto has_mpi () -> bool
 
void print_options ()
 
auto has_print_default_options () const -> bool
 
auto has_dump () const -> bool
 
void dump_options ()
 
void init ()
 
void run ()
 

Protected Member Functions

template<typename OptionType>
void ParseApplicationOptionImp (const std::vector< std::string > &filename, OptionType &option)
 

Private Member Functions

virtual void pre_init (FairRun *run)=0
 
virtual void ParseApplicationOption (const std::vector< std::string > &filename)=0
 
virtual void post_init (FairRun *run)
 
virtual void print_json_options ()
 
virtual void dump_json_options (const std::string &filename)
 
virtual void run_action (FairRun *run, int num_of_events)
 
virtual void setup_application_options (CLI::App &program_options)
 

Detailed Description

Definition at line 24 of file R3BNeulandApp.h.

Constructor & Destructor Documentation

◆ Application() [1/3]

R3B::Neuland::Application::Application ( std::string_view name,
std::unique_ptr< FairRun > run,
std::reference_wrapper< Options > option )
explicit

Definition at line 38 of file R3BNeulandApp.cxx.

◆ Application() [2/3]

R3B::Neuland::Application::Application ( const Application & )
delete

◆ Application() [3/3]

R3B::Neuland::Application::Application ( Application && )
delete

◆ ~Application()

R3B::Neuland::Application::~Application ( )
virtual

Definition at line 49 of file R3BNeulandApp.cxx.

Member Function Documentation

◆ dump_json_options() [1/2]

template<typename OptionType>
void R3B::Neuland::Application::dump_json_options ( const OptionType & options,
const std::string & filename )

Definition at line 163 of file R3BNeulandApp.h.

◆ dump_json_options() [2/2]

virtual void R3B::Neuland::Application::dump_json_options ( const std::string & filename)
inlineprivatevirtual

Reimplemented in R3B::Neuland::AnalysisApplication, and R3B::Neuland::SimulationApplication.

Definition at line 136 of file R3BNeulandApp.h.

◆ dump_options()

void R3B::Neuland::Application::dump_options ( )
inline

Definition at line 106 of file R3BNeulandApp.h.

◆ get_run()

auto R3B::Neuland::Application::get_run ( ) -> FairRun*
inline

Definition at line 100 of file R3BNeulandApp.h.

◆ has_dump()

auto R3B::Neuland::Application::has_dump ( ) const -> bool
inlinenodiscard

Definition at line 105 of file R3BNeulandApp.h.

◆ has_mpi()

auto R3B::Neuland::Application::has_mpi ( ) -> bool
inline

Definition at line 101 of file R3BNeulandApp.h.

◆ has_print_default_options()

auto R3B::Neuland::Application::has_print_default_options ( ) const -> bool
inlinenodiscard

Definition at line 104 of file R3BNeulandApp.h.

◆ init()

void R3B::Neuland::Application::init ( )

Definition at line 76 of file R3BNeulandApp.cxx.

◆ operator=() [1/2]

auto R3B::Neuland::Application::operator= ( Application && ) -> Application &=delete
delete

◆ operator=() [2/2]

auto R3B::Neuland::Application::operator= ( const Application & ) -> Application &=delete
delete

◆ ParseApplicationOption()

virtual void R3B::Neuland::Application::ParseApplicationOption ( const std::vector< std::string > & filename)
privatepure virtual

Implemented in R3B::Neuland::AnalysisApplication, and R3B::Neuland::SimulationApplication.

◆ ParseApplicationOptionImp()

template<typename OptionType>
void R3B::Neuland::Application::ParseApplicationOptionImp ( const std::vector< std::string > & filename,
OptionType & option )
protected

Definition at line 180 of file R3BNeulandApp.h.

◆ post_init()

virtual void R3B::Neuland::Application::post_init ( FairRun * run)
inlineprivatevirtual

Reimplemented in R3B::Neuland::SimulationApplication.

Definition at line 133 of file R3BNeulandApp.h.

◆ pre_init()

virtual void R3B::Neuland::Application::pre_init ( FairRun * run)
privatepure virtual

Implemented in R3B::Neuland::AnalysisApplication, and R3B::Neuland::SimulationApplication.

◆ print_json_options() [1/2]

virtual void R3B::Neuland::Application::print_json_options ( )
inlineprivatevirtual

Reimplemented in R3B::Neuland::AnalysisApplication, and R3B::Neuland::SimulationApplication.

Definition at line 135 of file R3BNeulandApp.h.

◆ print_json_options() [2/2]

template<typename OptionType>
void R3B::Neuland::Application::print_json_options ( const OptionType & options)

Definition at line 148 of file R3BNeulandApp.h.

◆ print_options()

void R3B::Neuland::Application::print_options ( )
inline

Definition at line 103 of file R3BNeulandApp.h.

◆ run()

void R3B::Neuland::Application::run ( )

Definition at line 228 of file R3BNeulandApp.cxx.

◆ run_action()

void R3B::Neuland::Application::run_action ( FairRun * run,
int num_of_events )
privatevirtual

Reimplemented in R3B::Neuland::SimulationApplication.

Definition at line 239 of file R3BNeulandApp.cxx.

◆ set_event_num()

void R3B::Neuland::Application::set_event_num ( int val)
inline

Definition at line 85 of file R3BNeulandApp.h.

◆ set_fail()

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

Definition at line 96 of file R3BNeulandApp.h.

◆ set_input_filename()

void R3B::Neuland::Application::set_input_filename ( const std::vector< std::string > & input_filename)
inline

Definition at line 86 of file R3BNeulandApp.h.

◆ set_inputpar_filename()

void R3B::Neuland::Application::set_inputpar_filename ( std::string_view inputpar_filename)
inline

Definition at line 76 of file R3BNeulandApp.h.

◆ set_log_level()

void R3B::Neuland::Application::set_log_level ( std::string_view log_level)
inline

Definition at line 73 of file R3BNeulandApp.h.

◆ set_num_of_procs()

void R3B::Neuland::Application::set_num_of_procs ( int val)
inline

Definition at line 94 of file R3BNeulandApp.h.

◆ set_output_filename()

void R3B::Neuland::Application::set_output_filename ( std::string_view output_filename)
inline

Definition at line 75 of file R3BNeulandApp.h.

◆ set_outputpar_filename()

void R3B::Neuland::Application::set_outputpar_filename ( std::string_view outputpar_filename)
inline

Definition at line 81 of file R3BNeulandApp.h.

◆ set_rank_num()

void R3B::Neuland::Application::set_rank_num ( int val)
inline

Definition at line 95 of file R3BNeulandApp.h.

◆ set_run_id()

void R3B::Neuland::Application::set_run_id ( int run_id)
inline

Definition at line 74 of file R3BNeulandApp.h.

◆ set_second_inputpar_filename()

void R3B::Neuland::Application::set_second_inputpar_filename ( std::string_view inputpar_filename)
inline

Definition at line 77 of file R3BNeulandApp.h.

◆ set_tree_input_filename()

void R3B::Neuland::Application::set_tree_input_filename ( const std::vector< std::string > & input_filename)
inline

Definition at line 90 of file R3BNeulandApp.h.

◆ setup_application_options()

virtual void R3B::Neuland::Application::setup_application_options ( CLI::App & program_options)
inlineprivatevirtual

Reimplemented in R3B::Neuland::AnalysisApplication.

Definition at line 138 of file R3BNeulandApp.h.

◆ setup_common_options()

template<typename CLIAPP, typename OptionType>
void R3B::Neuland::Application::setup_common_options ( CLIAPP & program_options,
OptionType & options )

◆ setup_options()

void R3B::Neuland::Application::setup_options ( CLI::App & program_options)

Definition at line 89 of file R3BNeulandApp.cxx.

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