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