Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
datatools::base_service Class Referenceabstract

The base service class. More...

#include <bayeux/datatools/base_service.h>

Inheritance diagram for datatools::base_service:
datatools::enriched_base datatools::i_serializable datatools::i_tree_dumpable cuts::cut_service datatools::library_query_service datatools::urn_db_service datatools::urn_query_service datatools::urn_to_path_resolver_service dpp::context_service dpp::histogram_service geomtools::geometry_service

Public Member Functions

 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 int initialize (const datatools::properties &config_, service_dict_type &service_dict_)=0
 Initialize the service using a list of properties with access to a dictionary of other services. More...
 
virtual int reset ()=0
 Reset the service. More...
 
virtual bool is_initialized () const =0
 Check if service is initialized. 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...
 
void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const override
 
- 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 tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) 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 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_)
 

Protected Member Functions

void _common_initialize (const datatools::properties &config_)
 Common initialization of services. More...
 
void common_initialize (const datatools::properties &config_)
 

Additional Inherited Members

- 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...
 

Detailed Description

The base service class.

The base_service class provides the interface of all datatools service objects.

Constructor & Destructor Documentation

◆ base_service() [1/2]

datatools::base_service::base_service ( )

Default constructor.

◆ base_service() [2/2]

datatools::base_service::base_service ( const std::string &  name_,
const std::string &  display_name_ = "",
const std::string &  description_ = "",
logger::priority  lp_ = logger::PRIO_FATAL 
)

Constructor.

◆ ~base_service()

virtual datatools::base_service::~base_service ( )
virtual

Destructor.

Member Function Documentation

◆ _common_initialize()

void datatools::base_service::_common_initialize ( const datatools::properties config_)
protected

Common initialization of services.

◆ common_initialize()

void datatools::base_service::common_initialize ( const datatools::properties config_)
protected

Common initialization of services

Deprecated:

◆ common_ocd()

static void datatools::base_service::common_ocd ( datatools::object_configuration_description ocd_)
static

Basic OCD support shared by all inherited modules.

◆ fetch_dependencies()

virtual void datatools::base_service::fetch_dependencies ( service_dependency_dict_type ) const
virtual

Undocumented unused/unimplemented method.

◆ initialize()

virtual int datatools::base_service::initialize ( const datatools::properties config_,
service_dict_type service_dict_ 
)
pure virtual

◆ initialize_simple()

virtual int datatools::base_service::initialize_simple ( )
virtual

Initialize the service without a list of properties nor other services.

◆ initialize_standalone()

virtual int datatools::base_service::initialize_standalone ( const datatools::properties config_)
virtual

Initialize the service using only a list of properties without the needs of other services.

◆ initialize_with_services()

virtual int datatools::base_service::initialize_with_services ( service_dict_type service_dict_)
virtual

Initialize the service using with access to a dictionary of other services.

◆ is_initialized()

virtual bool datatools::base_service::is_initialized ( ) const
pure virtual

◆ print_tree()

void datatools::base_service::print_tree ( std::ostream &  out_ = std::clog,
const boost::property_tree::ptree &  options_ = empty_options() 
) const
overridevirtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

◆ reset()

virtual int datatools::base_service::reset ( )
pure virtual

◆ service_class_id()

virtual std::string datatools::base_service::service_class_id ( ) const
pure virtual

Return the service class.

◆ tree_dump()

void datatools::base_service::tree_dump ( std::ostream &  out_ = std::clog,
const std::string &  title_ = "",
const std::string &  indent_ = "",
bool  inherit_ = false 
) const
overridevirtual

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