atlas::AtlasTool class
#include <atlas/runtime/AtlasTool.h>

Base classes

class eckit::Tool

Public types

using Options = std::vector<eckit::option::Option*>
using Args = eckit::option::CmdArgs

Public static functions

static auto success() -> int constexpr
static auto failed() -> int constexpr
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

Constructors, destructors, conversion operators

AtlasTool(int argc, char** argv)

Public functions

auto start() -> int
void run() virtual
auto execute(const Args&) -> int pure virtual
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

auto serial() -> bool virtual
auto indent() -> std::string virtual
auto briefDescription() -> std::string virtual
auto longDescription() -> std::string virtual
auto usage() -> std::string virtual
void help(std::ostream& out = Log::info()) virtual
auto numberOfPositionalArguments() -> int virtual
auto minimumPositionalArguments() -> int virtual

Function documentation

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

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

Platform agnostic hostname.

static void atlas::AtlasTool::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 atlas::AtlasTool::ready()
#include <eckit/runtime/Main.h>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Channel handling.

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

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