eckit::system::Plugin class
#include <eckit/system/Plugin.h>

Base classes

class Library

Derived classes

class atlas::Plugin

Public static functions

static auto list() -> std::vector<std::string> deprecated
static void list(std::ostream& s) deprecated
static auto exists(const std::string& name) -> bool deprecated
static auto lookup(const std::string& name) -> const Library& deprecated

Constructors, destructors, conversion operators

Plugin(const std::string& name, const std::string& libname = "") explicit
~Plugin() override

Public functions

auto name() const -> const std::string&
Plugin name.
auto libraryName() const -> const std::string&
Library name as will be used in file system.
void init() virtual
Initialisation function called after loading the plugin dynamically with dlopen()
void finalise() virtual
Finalisation function called before unloading the plugin dynamically with dlclose()
void handle(void* h)
auto handle() const -> void*
auto prefixDirectory() const -> std::string virtual
auto libraryHome() const -> std::string virtual
void libraryHome(const std::string&) virtual
auto expandPath(const std::string& path) const -> std::string virtual
auto libraryPath() const -> std::string
auto version() const -> std::string pure virtual
auto versionExtended() const -> std::string virtual
auto gitsha1(unsigned int count = 40) const -> std::string pure virtual
auto debug() const -> bool virtual
auto debugChannel() const -> Channel& virtual
auto configuration() const -> const Configuration& virtual
void lock()
void unlock()

Function documentation

static std::vector<std::string> eckit::system::Plugin::list()
#include <eckit/system/Library.h>

static void eckit::system::Plugin::list(std::ostream& s)
#include <eckit/system/Library.h>

static bool eckit::system::Plugin::exists(const std::string& name)
#include <eckit/system/Library.h>

static const Library& eckit::system::Plugin::lookup(const std::string& name)
#include <eckit/system/Library.h>

eckit::system::Plugin::Plugin(const std::string& name, const std::string& libname = "") explicit

Parameters
name in Plugin name
libname in Library name as will be used in file system

std::string eckit::system::Plugin::prefixDirectory() const virtual
#include <eckit/system/Library.h>

std::string eckit::system::Plugin::libraryHome() const virtual
#include <eckit/system/Library.h>

void eckit::system::Plugin::libraryHome(const std::string&) virtual
#include <eckit/system/Library.h>

std::string eckit::system::Plugin::expandPath(const std::string& path) const virtual
#include <eckit/system/Library.h>

std::string eckit::system::Plugin::libraryPath() const
#include <eckit/system/Library.h>

std::string eckit::system::Plugin::version() const pure virtual
#include <eckit/system/Library.h>

std::string eckit::system::Plugin::versionExtended() const virtual
#include <eckit/system/Library.h>

std::string eckit::system::Plugin::gitsha1(unsigned int count = 40) const pure virtual
#include <eckit/system/Library.h>

bool eckit::system::Plugin::debug() const virtual
#include <eckit/system/Library.h>

Channel& eckit::system::Plugin::debugChannel() const virtual
#include <eckit/system/Library.h>

const Configuration& eckit::system::Plugin::configuration() const virtual
#include <eckit/system/Library.h>

void eckit::system::Plugin::lock()
#include <eckit/system/Library.h>

void eckit::system::Plugin::unlock()
#include <eckit/system/Library.h>