Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Types | Public Member Functions | Static Public Member Functions | List of all members
datatools::urn_to_path_resolver_service Class Reference

URN to file path resolver service. More...

#include <bayeux/datatools/urn_to_path_resolver_service.h>

Inheritance diagram for datatools::urn_to_path_resolver_service:
datatools::base_service datatools::enriched_base datatools::i_serializable datatools::i_tree_dumpable

Public Types

typedef urn_to_path resolver_entry
 
typedef std::map< std::string, resolver_entryurn_lookup_table_type
 URN to path lookup table. More...
 
- Public Types inherited from datatools::enriched_base
enum  export_config_flags {
  EXPORT_CONFIG_CLEAR = bit_mask::bit00, EXPORT_CONFIG_NAME = bit_mask::bit01, EXPORT_CONFIG_DISPLAY_NAME = bit_mask::bit02, EXPORT_CONFIG_TERSE_DESCRIPTION = bit_mask::bit03,
  EXPORT_CONFIG_LOGGING_PRIORITY = bit_mask::bit04, EXPORT_CONFIG_AUXILIARIES = bit_mask::bit05, EXPORT_CONFIG_DEFAULT, EXPORT_CONFIG_LAST = EXPORT_CONFIG_AUXILIARIES
}
 Flags for export to a container of properties. More...
 
- Public Types inherited from datatools::i_tree_dumpable
enum  ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
 Enumeration for standard output streams. More...
 

Public Member Functions

 urn_to_path_resolver_service ()
 Constructor. More...
 
virtual ~urn_to_path_resolver_service ()
 Destructor. More...
 
void add_known_category (const std::string &cat_)
 Add a known catagory. More...
 
void remove_known_category (const std::string &cat_)
 Remove a known catagory. More...
 
void clear_known_categories ()
 Clear known categories. More...
 
const std::set< std::string > & get_known_categories () const
 Return the known categories. More...
 
bool is_allow_overloading () const
 Check if URN overloading is allowed. More...
 
void set_allow_overloading (bool)
 Set the URN overloading flag. More...
 
void add_map (const std::string &)
 Add a map file. More...
 
virtual bool is_initialized () const
 Check initialization status. More...
 
virtual int initialize (const datatools::properties &config_, datatools::service_dict_type &services_)
 Initialize the service from a list of properties. More...
 
virtual int reset ()
 Reset. More...
 
virtual void tree_dump (std::ostream &out=std::clog, const std::string &title="", const std::string &indent="", bool inherit=false) const
 Smart print. More...
 
void load_map (const std::string &map_filename_)
 Load a URN/path map file. More...
 
bool urn_is_known (const std::string &urn_) const
 Check is a given URN is known. More...
 
std::string resolve (const std::string &urn_) const
 Return the path associated to a given URN. More...
 
void add_entry (const std::string &urn_, const std::string &category_, const datatools::properties &infos_)
 Add entry in the URN path lockup table. More...
 
void add_entry (const std::string &urn_, const std::string &category_, const std::string &path_, const std::string &mime_="")
 Add entry in the URN path lockup table. More...
 
void remove (const std::string &urn_)
 Remove an entry. More...
 
std::size_t size () const
 Return the size of the lookup table. More...
 
const resolver_entryget_entry (const std::string &urn_) const
 Return the entry associated to a given URN. More...
 
const std::string & get_category (const std::string &urn_) const
 Return the category associated to a given URN. More...
 
const std::string & get_path (const std::string &urn_) const
 Return the path associated to a given URN. More...
 
const std::string & get_mime (const std::string &urn_) const
 Return the MIME associated to a given URN. More...
 
void print_lookup_table (std::ostream &=std::clog, const uint32_t flags_=0) const
 Print the URN lookup table. More...
 
const urn_lookup_table_typeget_urn_lookup_table () const
 Return the URN lookup table. More...
 
void kernel_push (const std::string &="")
 Add to system. More...
 
void kernel_pop ()
 Remove from system. More...
 
bool is_kernel_pushed () const
 Check if the service is pushed (registered) in the kernel. More...
 
- Public Member Functions inherited from datatools::base_service
 base_service ()
 Default constructor. More...
 
 base_service (const std::string &name_, const std::string &display_name_="", const std::string &description_="", logger::priority lp_=logger::PRIO_FATAL)
 Constructor. More...
 
virtual ~base_service ()
 Destructor. More...
 
virtual void fetch_dependencies (service_dependency_dict_type &) const
 Undocumented unused/unimplemented method. More...
 
virtual int initialize_simple ()
 Initialize the service without a list of properties nor other services. More...
 
virtual int initialize_standalone (const datatools::properties &config_)
 Initialize the service using only a list of properties without the needs of other services. More...
 
virtual int initialize_with_services (service_dict_type &service_dict_)
 Initialize the service using with access to a dictionary of other services. More...
 
virtual std::string service_class_id () const =0
 Return the service class. More...
 
void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const override
 Smart print. More...
 
- Public Member Functions inherited from datatools::enriched_base
virtual bool is_name_valid (const std::string &name_) const
 Check if a name is valid. More...
 
 enriched_base ()
 Default constructor. More...
 
 enriched_base (const std::string &name_, const std::string &display_name_="", const std::string &terse_description_="", logger::priority lp_=logger::PRIO_FATAL)
 Constructor. More...
 
virtual ~enriched_base ()
 Destructor. More...
 
bool has_name () const
 Check if the name is not empty. More...
 
void set_name (const std::string &name_)
 Set the name. More...
 
enriched_baseset_name_c (const std::string &name_)
 Set the name. More...
 
const std::string & get_name () const
 Return the name. More...
 
void reset_name ()
 Reset the name. More...
 
bool has_display_name () const
 Check if the display name is empty. More...
 
void set_display_name (const std::string &display_name_)
 Set the display name. More...
 
enriched_baseset_display_name_c (const std::string &display_name_)
 Set the display name. More...
 
const std::string & get_display_name () const
 Return the display name. More...
 
bool has_terse_description () const
 Check if the description is empty. More...
 
void set_terse_description (const std::string &terse_description_)
 Set the description. More...
 
enriched_baseset_terse_description_c (const std::string &terse_description_)
 Set the description. More...
 
const std::string & get_terse_description () const
 Return the description. More...
 
bool has_auxiliaries () const
 Check if the container of auxiliary properties is empty. More...
 
const datatools::propertiesget_auxiliaries () const
 Return a reference to the non mutable container of auxiliary properties. More...
 
datatools::propertiesgrab_auxiliaries ()
 Return a reference to the mutable container of auxiliary properties. More...
 
void reset_auxiliaries ()
 Remove all auxiliary properties. More...
 
bool is_debug () const
 Check the debug status. More...
 
void set_logging_priority (logger::priority lp_)
 Set the logging priority threshold. More...
 
enriched_baseset_logging_priority_c (logger::priority lp_)
 Set the logging priority threshold. More...
 
void set_logging (const std::string &label_)
 Set the logging priority threshold from a string. More...
 
logger::priority get_logging_priority () const
 Return the logging priority threshold. More...
 
void clear ()
 Clear. More...
 
void reset ()
 Clear. More...
 
void print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const override
 Smart print. More...
 
void initialize (const datatools::properties &config_, bool clear_=false)
 Initialization from a container of properties. More...
 
void export_to_config (datatools::properties &config_, uint32_t flags_=EXPORT_CONFIG_DEFAULT, const std::string &prefix_="") const
 Export to a container of properties. More...
 
- Public Member Functions inherited from datatools::i_serializable
 i_serializable ()
 Default constructor. More...
 
virtual ~i_serializable ()
 Destructor. More...
 
virtual const std::string & get_serial_tag () const =0
 Return the serialization string identifier of the class. More...
 
- Public Member Functions inherited from datatools::i_tree_dumpable
 i_tree_dumpable ()
 Constructor. More...
 
virtual ~i_tree_dumpable ()
 Destructor. More...
 
void print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
 Printing with jsonized options. More...
 
void print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
 Printing with jsonized options. More...
 
void tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const
 
void tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const
 
void smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const
 

Static Public Member Functions

static const std::set< std::string > & default_known_categories ()
 Return the default list of known categories. More...
 
- Static Public Member Functions inherited from datatools::base_service
static void common_ocd (datatools::object_configuration_description &ocd_)
 Basic OCD support shared by all inherited modules. More...
 
- Static Public Member Functions inherited from datatools::enriched_base
static bool validate_name (const std::string &candidate_name_)
 Validate a name. More...
 
static logger::priority default_logging_priority ()
 Return the default logging priority threshold. More...
 
static void init_ocd (datatools::object_configuration_description &)
 OCD support. More...
 
- Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree & empty_options ()
 
static boost::property_tree::ptree make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)
 
static std::ostream & last_skip_tag (std::ostream &out_)
 
static std::ostream & skip_tag (std::ostream &out_)
 
static std::ostream & last_tag (std::ostream &out_)
 
static std::ostream & tag (std::ostream &out_)
 

Additional Inherited Members

- Protected Member Functions inherited from datatools::base_service
void _common_initialize (const datatools::properties &config_)
 Common initialization of services. More...
 
void common_initialize (const datatools::properties &config_)
 

Detailed Description

URN to file path resolver service.

A service which associated a file path to its unique URN. URN format:

urn:<SEGMENTS>

Examples:

urn:snemo:demonstrator:geometry:4.0:variants
urn:bipo:geometry:2.3:plugins

Member Typedef Documentation

◆ resolver_entry

◆ urn_lookup_table_type

URN to path lookup table.

Constructor & Destructor Documentation

◆ urn_to_path_resolver_service()

datatools::urn_to_path_resolver_service::urn_to_path_resolver_service ( )

Constructor.

◆ ~urn_to_path_resolver_service()

virtual datatools::urn_to_path_resolver_service::~urn_to_path_resolver_service ( )
virtual

Destructor.

Member Function Documentation

◆ add_entry() [1/2]

void datatools::urn_to_path_resolver_service::add_entry ( const std::string &  urn_,
const std::string &  category_,
const datatools::properties infos_ 
)

Add entry in the URN path lockup table.

◆ add_entry() [2/2]

void datatools::urn_to_path_resolver_service::add_entry ( const std::string &  urn_,
const std::string &  category_,
const std::string &  path_,
const std::string &  mime_ = "" 
)

Add entry in the URN path lockup table.

◆ add_known_category()

void datatools::urn_to_path_resolver_service::add_known_category ( const std::string &  cat_)

Add a known catagory.

◆ add_map()

void datatools::urn_to_path_resolver_service::add_map ( const std::string &  )

Add a map file.

◆ clear_known_categories()

void datatools::urn_to_path_resolver_service::clear_known_categories ( )

Clear known categories.

◆ default_known_categories()

static const std::set<std::string>& datatools::urn_to_path_resolver_service::default_known_categories ( )
static

Return the default list of known categories.

◆ get_category()

const std::string& datatools::urn_to_path_resolver_service::get_category ( const std::string &  urn_) const

Return the category associated to a given URN.

◆ get_entry()

const resolver_entry& datatools::urn_to_path_resolver_service::get_entry ( const std::string &  urn_) const

Return the entry associated to a given URN.

◆ get_known_categories()

const std::set<std::string>& datatools::urn_to_path_resolver_service::get_known_categories ( ) const

Return the known categories.

◆ get_mime()

const std::string& datatools::urn_to_path_resolver_service::get_mime ( const std::string &  urn_) const

Return the MIME associated to a given URN.

◆ get_path()

const std::string& datatools::urn_to_path_resolver_service::get_path ( const std::string &  urn_) const

Return the path associated to a given URN.

◆ get_urn_lookup_table()

const urn_lookup_table_type& datatools::urn_to_path_resolver_service::get_urn_lookup_table ( ) const

Return the URN lookup table.

◆ initialize()

virtual int datatools::urn_to_path_resolver_service::initialize ( const datatools::properties config_,
datatools::service_dict_type services_ 
)
virtual

Initialize the service from a list of properties.

Implements datatools::base_service.

◆ is_allow_overloading()

bool datatools::urn_to_path_resolver_service::is_allow_overloading ( ) const

Check if URN overloading is allowed.

◆ is_initialized()

virtual bool datatools::urn_to_path_resolver_service::is_initialized ( ) const
virtual

Check initialization status.

Implements datatools::base_service.

◆ is_kernel_pushed()

bool datatools::urn_to_path_resolver_service::is_kernel_pushed ( ) const

Check if the service is pushed (registered) in the kernel.

◆ kernel_pop()

void datatools::urn_to_path_resolver_service::kernel_pop ( )

Remove from system.

◆ kernel_push()

void datatools::urn_to_path_resolver_service::kernel_push ( const std::string &  = "")

Add to system.

◆ load_map()

void datatools::urn_to_path_resolver_service::load_map ( const std::string &  map_filename_)

Load a URN/path map file.

◆ print_lookup_table()

void datatools::urn_to_path_resolver_service::print_lookup_table ( std::ostream &  = std::clog,
const uint32_t  flags_ = 0 
) const

Print the URN lookup table.

◆ remove()

void datatools::urn_to_path_resolver_service::remove ( const std::string &  urn_)

Remove an entry.

◆ remove_known_category()

void datatools::urn_to_path_resolver_service::remove_known_category ( const std::string &  cat_)

Remove a known catagory.

◆ reset()

virtual int datatools::urn_to_path_resolver_service::reset ( )
virtual

Reset.

Implements datatools::base_service.

◆ resolve()

std::string datatools::urn_to_path_resolver_service::resolve ( const std::string &  urn_) const

Return the path associated to a given URN.

◆ set_allow_overloading()

void datatools::urn_to_path_resolver_service::set_allow_overloading ( bool  )

Set the URN overloading flag.

◆ size()

std::size_t datatools::urn_to_path_resolver_service::size ( ) const

Return the size of the lookup table.

◆ tree_dump()

virtual void datatools::urn_to_path_resolver_service::tree_dump ( std::ostream &  out = std::clog,
const std::string &  title = "",
const std::string &  indent = "",
bool  inherit = false 
) const
virtual

Smart print.

Reimplemented from datatools::base_service.

◆ urn_is_known()

bool datatools::urn_to_path_resolver_service::urn_is_known ( const std::string &  urn_) const

Check is a given URN is known.


The documentation for this class was generated from the following file: