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

Example of an Elements program. More...

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

Public Member Functions

void defineOptions () override
 
ExitCode main () override
 The "main" method. More...
 
- Public Member Functions inherited from Elements::SimpleProgram
ELEMENTS_API ExitCode run (int argc, char **argv) noexcept
 
ELEMENTS_API const boost::filesystem::path & getProgramPath () const
 
ELEMENTS_API const boost::filesystem::path & getProgramName () const
 

Additional Inherited Members

- Protected Member Functions inherited from Elements::SimpleProgram
 SimpleProgram ()=default
 
virtual ~SimpleProgram ()
 

Detailed Description

Example of an Elements program.

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

Examples:
ElementsExamples/src/program/AnotherSimpleProgramExample.cpp.

Definition at line 40 of file AnotherSimpleProgramExample.cpp.

Member Function Documentation

◆ defineOptions()

void Elements::Examples::AnotherSimpleProgramExample::defineOptions ( )
inlineoverridevirtual

◆ main()

ExitCode Elements::Examples::AnotherSimpleProgramExample::main ( )
inlineoverridevirtual

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 main()). The code below provides only example stuff which should be replaced by real code in any program.

See the SimpleProgram documentation for more details.

Implements Elements::SimpleProgram.

Examples:
ElementsExamples/src/program/AnotherSimpleProgramExample.cpp.

Definition at line 59 of file AnotherSimpleProgramExample.cpp.

References std::endl(), Elements::SimpleProgram::getProgramName(), Elements::SimpleProgram::getProgramPath(), and Elements::OK.

Here is the call graph for this function:

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