 |
Bayeux
3.4.1
Core Foundation library for SuperNEMO
|
|
Bayeux
3.4.1
Core Foundation library for SuperNEMO
|
Top-level namespace of the Bayeux library. More...
Namespaces | |
| detail | |
Classes | |
| struct | version |
| Describe the Bayeux API version and features. More... | |
Enumerations | |
| enum | bayeux_init_flags { bxinit_no_help = datatools::init_no_help, init_dtkernel_no_help = datatools::init_no_help, bxinit_no_splash = datatools::init_no_splash, init_dtkernel_no_splash = datatools::init_no_splash, bxinit_no_locale_category = datatools::init_no_locale_category, init_dtkernel_no_locale_category = datatools::init_no_locale_category, bxinit_no_logging = datatools::init_no_logging, init_dtkernel_no_logging = datatools::init_no_logging, bxinit_no_inhibit_libquery = datatools::init_no_inhibit_libquery, init_dtkernel_no_inhibit_libquery = datatools::init_no_inhibit_libquery, init_dtkernel_no_inhibit_libinfo = datatools::init_no_inhibit_libquery, bxinit_no_libinfo_logging = datatools::init_no_libinfo_logging, init_dtkernel_no_libinfo_logging = datatools::init_no_libinfo_logging, bxinit_no_resource_path = datatools::init_no_resource_path, init_dtkernel_no_resource_path = datatools::init_no_resource_path, bxinit_no_inhibit_variant = datatools::init_no_inhibit_variant, init_dtkernel_no_inhibit_variant = datatools::init_no_inhibit_variant, bxinit_no_variant = datatools::init_no_variant, init_dtkernel_no_variant = datatools::init_no_variant, bxinit_no_inhibit_qt_gui = datatools::init_no_inhibit_qt_gui, init_dtkernel_no_inhibit_qt_gui = datatools::init_no_inhibit_qt_gui, bxinit_no_inhibit_urnquery = datatools::init_no_inhibit_urnquery, init_dtkernel_no_inhibit_urnquery = datatools::init_no_inhibit_urnquery, bxinit_reserved_11 = datatools::init_reserved_11, init_dtkernel_reserved_11 = datatools::init_reserved_11, bxinit_reserved_12 = datatools::init_reserved_12, init_dtkernel_reserved_12 = datatools::init_reserved_12, bxinit_reserved_13 = datatools::init_reserved_13, init_dtkernel_reserved_13 = datatools::init_reserved_13, bxinit_reserved_14 = datatools::init_reserved_14, init_dtkernel_reserved_14 = datatools::init_reserved_14, bxinit_kernel_inhibit = datatools::init_kernel_inhibit, init_dtkernel_inhibit = datatools::init_kernel_inhibit, bxinit_max_flags = init_dtkernel_inhibit } |
| Bayeux initialization flags. More... | |
Functions | |
| bool | is_initialized () |
| Check if Bayeux library core functionnalities are initialized. More... | |
| void | initialize (int argc_=0, char *argv_[]=nullptr, uint32_t flags_=0) |
| Initialize the Bayeux library core functionnalities. More... | |
| void | terminate () |
| Terminate the Bayeux library core functionnalities. More... | |
| int | init_directories () |
| Init directories. More... | |
| std::string | get_prefix_dir () |
| Return URL, i.e. a path, to the installation directory where Bayeux is installed. More... | |
| std::string | get_binary_dir () |
| Return URL, i.e. a path, to the directory where Bayeux's executable are installed. More... | |
| std::string | get_library_dir () |
| Return URL, i.e. a path, to the directory where Bayeux's libraries are installed. More... | |
| std::string | get_data_dir () |
| Return URL, i.e. a path, to the base directory where Bayeux's data are installed. More... | |
| std::string | get_resource_dir () |
| Return URL, i.e. a path, to the base directory where Bayeux's modules' resource files are installed. More... | |
| std::string | get_bayeux_resource_dir (bool overriden_env=false) |
| std::string | get_bayeux_resource (const std::string &rname, bool overriden_env=false) |
Top-level namespace of the Bayeux library.
Bayeux initialization flags.
Bits 0-14 : reserved to the datatools' kernel initialization Bits 15 : datatools' kernel inhibition Bits 16-31 : unused, available for client packages
| std::string bayeux::get_bayeux_resource | ( | const std::string & | rname, |
| bool | overriden_env = false |
||
| ) |
Return URL, i.e. a path, to named resource By default the encoded resource root, determined at compile time is used to search for the resource. This can be overriden by setting the BAYEUX_RESOURCE_DIR environment variable to a path holding custom resources.
| rname | name of resource, given as a path relative to resource root. |
| overriden_env | flag to allow path overriding by the BAYEUX_RESOURCE_DIR environment variable. |
| std::string bayeux::get_bayeux_resource_dir | ( | bool | overriden_env = false | ) |
Return URL, i.e. a path, to the base directory where resource files are installed
| overriden_env | If set this flag trigger the search for the environment variable BAYEUX_RESOURCE_DIR as a directory path on the filesystem as an alternative base directory for resources in place of the standard installation path |
| std::string bayeux::get_binary_dir | ( | ) |
Return URL, i.e. a path, to the directory where Bayeux's executable are installed.
| std::string bayeux::get_data_dir | ( | ) |
Return URL, i.e. a path, to the base directory where Bayeux's data are installed.
| std::string bayeux::get_library_dir | ( | ) |
Return URL, i.e. a path, to the directory where Bayeux's libraries are installed.
| std::string bayeux::get_prefix_dir | ( | ) |
Return URL, i.e. a path, to the installation directory where Bayeux is installed.
| std::string bayeux::get_resource_dir | ( | ) |
Return URL, i.e. a path, to the base directory where Bayeux's modules' resource files are installed.
| int bayeux::init_directories | ( | ) |
Init directories.
| void bayeux::initialize | ( | int | argc_ = 0, |
| char * | argv_[] = nullptr, |
||
| uint32_t | flags_ = 0 |
||
| ) |
Initialize the Bayeux library core functionnalities.
| bool bayeux::is_initialized | ( | ) |
Check if Bayeux library core functionnalities are initialized.
| void bayeux::terminate | ( | ) |
Terminate the Bayeux library core functionnalities.
1.8.15