Elements 6.3.3
A C++ base framework for the Euclid Software.
Loading...
Searching...
No Matches
Elements::SimpleProgram Class Referenceabstract

#include <SimpleProgram.h>

Public Types

using ExitCode = Elements::ExitCode
using Logging = Elements::Logging

Public Member Functions

ExitCode run (int argc, char **argv) noexcept
const Path::Item & getProgramPath () const
const Path::Item & getProgramName () const

Protected Member Functions

 SimpleProgram ()=default
virtual ~SimpleProgram ()
virtual ExitCode main ()=0
virtual void defineOptions ()=0

Private Member Functions

void setup (int argc, char **argv)

Private Attributes

Path::Item m_program_name
Path::Item m_program_path

Detailed Description

Definition at line 41 of file SimpleProgram.h.

Member Typedef Documentation

◆ ExitCode

◆ Logging

Constructor & Destructor Documentation

◆ SimpleProgram()

Elements::SimpleProgram::SimpleProgram ( )
protecteddefault

References SimpleProgram().

Referenced by SimpleProgram().

Here is the call graph for this function:

◆ ~SimpleProgram()

Elements::SimpleProgram::~SimpleProgram ( )
protectedvirtual

Definition at line 33 of file SimpleProgram.cpp.

Member Function Documentation

◆ defineOptions()

virtual void Elements::SimpleProgram::defineOptions ( )
protectedpure virtual

References setup().

Referenced by setup().

Here is the call graph for this function:

◆ getProgramName()

const Path::Item & Elements::SimpleProgram::getProgramName ( ) const

Definition at line 71 of file SimpleProgram.cpp.

References m_program_name.

◆ getProgramPath()

const Path::Item & Elements::SimpleProgram::getProgramPath ( ) const

Definition at line 67 of file SimpleProgram.cpp.

References m_program_path.

◆ main()

virtual ExitCode Elements::SimpleProgram::main ( )
protectedpure virtual

Referenced by run().

◆ run()

ExitCode Elements::SimpleProgram::run ( int argc,
char ** argv )
noexcept

Definition at line 35 of file SimpleProgram.cpp.

References endl(), std::endl(), main(), Elements::NOT_OK, and setup().

Here is the call graph for this function:

◆ setup()

void Elements::SimpleProgram::setup ( int argc,
char ** argv )
private

Definition at line 57 of file SimpleProgram.cpp.

References defineOptions(), ELEMENTS_UNUSED, m_program_name, and m_program_path.

Referenced by defineOptions(), and run().

Here is the call graph for this function:

Member Data Documentation

◆ m_program_name

Path::Item Elements::SimpleProgram::m_program_name
private

Definition at line 62 of file SimpleProgram.h.

Referenced by getProgramName(), and setup().

◆ m_program_path

Path::Item Elements::SimpleProgram::m_program_path
private

Definition at line 63 of file SimpleProgram.h.

Referenced by getProgramPath(), and setup().


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