Elements  5.10
A C++ base framework for the Euclid Software.
Public Member Functions | List of all members
Elements::Examples::SimpleProgramExample Class Reference

Example of an Elements program. More...

Inheritance diagram for Elements::Examples::SimpleProgramExample:
[legend]
Collaboration diagram for Elements::Examples::SimpleProgramExample:
[legend]

Public Member Functions

ExitCode mainMethod (ELEMENTS_UNUSED map< string, variable_value > &args) override
 The "main" method. More...
 
- Public Member Functions inherited from Elements::Program
 Program ()=default
 Constructor. More...
 
virtual ~Program ()
 Destructor. More...
 
virtual boost::program_options::options_description defineSpecificProgramOptions ()
 This methods must be used to define specific program options. More...
 
virtual std::pair< boost::program_options::options_description, boost::program_options::positional_options_description > defineProgramArguments ()
 This methods must be used to the program arguments. More...
 
virtual ExitCode mainMethod (std::map< std::string, boost::program_options::variable_value > &args)=0
 This is the "main" method of all Elements programs. More...
 

Detailed Description

Example of an Elements program.

This class is an example of a program based on the ElementsProgram class. It can be copied/pasted conveniently to write a new program.

Examples
ElementsExamples/src/program/SimpleProgramExample.cpp.

Definition at line 49 of file SimpleProgramExample.cpp.

Member Function Documentation

◆ mainMethod()

ExitCode Elements::Examples::SimpleProgramExample::mainMethod ( ELEMENTS_UNUSED map< string, variable_value > &  args)
inlineoverride

The "main" method.

This method is the entry point to the program. In this sense, it is similar to a main (and it is why it is called mainMethod()). The code below provides only example stuff which should be replaced by real code in any program.

See the ElementsProgram documentation for more details.

Examples
ElementsExamples/src/program/SimpleProgramExample.cpp.

Definition at line 64 of file SimpleProgramExample.cpp.

References std::endl(), Elements::Logging::getLogger(), Elements::Examples::log, Elements::nanoSleep(), and Elements::OK.

Here is the call graph for this function:

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