eckit::EckitTool class
#include <eckit/option/EckitTool.h>

Base classes

class Tool

Public static functions

static auto instance() -> Main&
static auto hostname() -> std::string
Platform agnostic hostname.
static void initialise(int argc, char** argv, const char* homeenv = nullptr)
static auto ready() -> bool

Public functions

void usage(const std::string& tool) const pure virtual
auto start() -> int
auto createWarningLogTarget() const -> LogTarget* override
auto createErrorLogTarget() const -> LogTarget* override
auto argc() const -> int
auto argv() const -> char**
auto argv(int n) const -> std::string
auto home() const -> const std::string&
void terminate() virtual
auto taskID() const -> long
void taskID(long)
auto name() const -> const std::string& virtual
Name of the program as called from the command-line.
auto displayName() const -> const std::string& virtual
auto debug() const -> bool virtual
auto createInfoLogTarget() const -> LogTarget* virtual
Channel handling.
auto createDebugLogTarget() const -> LogTarget* virtual
auto createMetricsLogTarget() const -> LogTarget* virtual

Private functions

void init(const option::CmdArgs&) virtual
void execute(const option::CmdArgs&) pure virtual
void finish(const option::CmdArgs&) virtual
auto numberOfPositionalArguments() const -> int virtual
auto minimumPositionalArguments() const -> int virtual
void run() override

Function documentation

static Main& eckit::EckitTool::instance()
#include <eckit/runtime/Main.h>

static std::string eckit::EckitTool::hostname()
#include <eckit/runtime/Main.h>

Platform agnostic hostname.

static void eckit::EckitTool::initialise(int argc, char** argv, const char* homeenv = nullptr)
#include <eckit/runtime/Main.h>

Ensure that there exits a Main object. This is to be used For unit tests and fortran bindinds only

static bool eckit::EckitTool::ready()
#include <eckit/runtime/Main.h>

int eckit::EckitTool::start()
#include <eckit/runtime/Tool.h>

LogTarget* eckit::EckitTool::createWarningLogTarget() const override
#include <eckit/runtime/Tool.h>

LogTarget* eckit::EckitTool::createErrorLogTarget() const override
#include <eckit/runtime/Tool.h>

int eckit::EckitTool::argc() const
#include <eckit/runtime/Main.h>

char** eckit::EckitTool::argv() const
#include <eckit/runtime/Main.h>

std::string eckit::EckitTool::argv(int n) const
#include <eckit/runtime/Main.h>

const std::string& eckit::EckitTool::home() const
#include <eckit/runtime/Main.h>

void eckit::EckitTool::terminate() virtual
#include <eckit/runtime/Main.h>

long eckit::EckitTool::taskID() const
#include <eckit/runtime/Main.h>

void eckit::EckitTool::taskID(long)
#include <eckit/runtime/Main.h>

const std::string& eckit::EckitTool::name() const virtual
#include <eckit/runtime/Main.h>

Name of the program as called from the command-line.

const std::string& eckit::EckitTool::displayName() const virtual
#include <eckit/runtime/Main.h>

Name to display in logs. Default is name(), but can be configured differently.

bool eckit::EckitTool::debug() const virtual
#include <eckit/runtime/Main.h>

LogTarget* eckit::EckitTool::createInfoLogTarget() const virtual
#include <eckit/runtime/Main.h>

Channel handling.

LogTarget* eckit::EckitTool::createDebugLogTarget() const virtual
#include <eckit/runtime/Main.h>

LogTarget* eckit::EckitTool::createMetricsLogTarget() const virtual
#include <eckit/runtime/Main.h>