Example of an Elements program. More...
Inheritance diagram for Elements::Examples::SimpleProgram:
Collaboration diagram for Elements::Examples::SimpleProgram:
Public Member Functions | |
| ExitCode | mainMethod (ELEMENTS_UNUSED map< string, VariableValue > &args) override |
| The "main" method. More... | |
 Public Member Functions inherited from Elements::Examples::Program | |
| OptionsDescription | defineSpecificProgramOptions () override |
| Allows to define the (command line and configuration file) options specific to this program. More... | |
| ExitCode | mainMethod (map< string, VariableValue > &args) override |
| The "main" method. More... | |
| Public Member Functions inherited from Elements::Program | |
| Program ()=default | |
| Constructor. More... | |
| virtual | ~Program () |
| Destructor. More... | |
| virtual std::pair< OptionsDescription, PositionalOptionsDescription > | defineProgramArguments () |
| This methods must be used to the program arguments. More... | |
Additional Inherited Members | |
| Public Types inherited from Elements::Program | |
| using | options_description = boost::program_options::options_description |
| using | positional_options_description = boost::program_options::positional_options_description |
| using | variable_value = boost::program_options::variable_value |
| using | variables_map = boost::program_options::variables_map |
| using | OptionsDescription = options_description |
| using | PositionalOptionsDescription = positional_options_description |
| using | VariableValue = variable_value |
| using | VariablesMap = variables_map |
| using | ExitCode = Elements::ExitCode |
| using | Logging = Elements::Logging |
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.
Definition at line 44 of file SimpleProgram.cpp.
Member Function Documentation
◆ mainMethod()
|
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.
Definition at line 58 of file SimpleProgram.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:
- ElementsExamples/src/program/SimpleProgram.cpp
