atlas::Plugin class
#include <atlas/library/Plugin.h>

Base classes

class eckit::system::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() virtual

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> atlas::Plugin::list()
#include <eckit/system/Library.h>

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

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

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

atlas::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

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

Plugin name.

const std::string& atlas::Plugin::libraryName() const
#include <eckit/system/Plugin.h>

Library name as will be used in file system.

void atlas::Plugin::init() virtual
#include <eckit/system/Plugin.h>

Initialisation function called after loading the plugin dynamically with dlopen()

void atlas::Plugin::finalise() virtual
#include <eckit/system/Plugin.h>

Finalisation function called before unloading the plugin dynamically with dlclose()

void atlas::Plugin::handle(void* h)
#include <eckit/system/Plugin.h>

void* atlas::Plugin::handle() const
#include <eckit/system/Plugin.h>

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

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

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

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

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

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

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

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

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

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

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

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

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