Bayeux  3.4.1
Core Foundation library for SuperNEMO
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
datatools::detail::ocd::ocd_registration Class Reference

OCD registration container. More...

#include <bayeux/datatools/detail/ocd_utils.h>

Classes

struct  entry_type
 Internal entry to handle the OCD data associated to a class. More...
 

Public Types

typedef boost::shared_ptr< object_configuration_descriptionocd_handle_type
 Handle to the OCD data associated to a class. More...
 
typedef std::map< std::string, entry_typeocd_dict_type
 The dictionary of OCD data handle. More...
 

Public Member Functions

bool is_system () const
 Check if the current instance is the system singleton OCD registration. More...
 
 ocd_registration (bool preload_system_registration_=false)
 Constructor. More...
 
 ~ocd_registration ()
 Destructor. More...
 
bool has_id (const std::string &class_id_) const
 Check if a class Id is registered in the registration container. More...
 
const object_configuration_descriptionget (const std::string &class_id_) const
 Fetch the OCD data associated to a given registered class Id. More...
 
template<class T >
void registration (const std::string &class_name_, const ocd_handle_type &handle_)
 
template<class T >
void unregistration (const std::string &class_name_)
 
void smart_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="") const
 Smart print. More...
 
void compute_ids (std::vector< std::string > &) const
 Compute the list of registered class Ids. More...
 

Static Public Member Functions

static ocd_registrationgrab_system_registration ()
 
static const ocd_registrationget_system_registration ()
 

Protected Member Functions

void _preload_system_registration ()
 

Detailed Description

OCD registration container.

Member Typedef Documentation

◆ ocd_dict_type

The dictionary of OCD data handle.

◆ ocd_handle_type

Handle to the OCD data associated to a class.

Constructor & Destructor Documentation

◆ ocd_registration()

datatools::detail::ocd::ocd_registration::ocd_registration ( bool  preload_system_registration_ = false)

Constructor.

◆ ~ocd_registration()

datatools::detail::ocd::ocd_registration::~ocd_registration ( )

Destructor.

Member Function Documentation

◆ _preload_system_registration()

void datatools::detail::ocd::ocd_registration::_preload_system_registration ( )
protected

◆ compute_ids()

void datatools::detail::ocd::ocd_registration::compute_ids ( std::vector< std::string > &  ) const

Compute the list of registered class Ids.

◆ get()

const object_configuration_description& datatools::detail::ocd::ocd_registration::get ( const std::string &  class_id_) const

Fetch the OCD data associated to a given registered class Id.

◆ get_system_registration()

static const ocd_registration& datatools::detail::ocd::ocd_registration::get_system_registration ( )
static

◆ grab_system_registration()

static ocd_registration& datatools::detail::ocd::ocd_registration::grab_system_registration ( )
static

◆ has_id()

bool datatools::detail::ocd::ocd_registration::has_id ( const std::string &  class_id_) const

Check if a class Id is registered in the registration container.

◆ is_system()

bool datatools::detail::ocd::ocd_registration::is_system ( ) const

Check if the current instance is the system singleton OCD registration.

◆ registration()

template<class T >
void datatools::detail::ocd::ocd_registration::registration ( const std::string &  class_name_,
const ocd_handle_type handle_ 
)

◆ smart_dump()

void datatools::detail::ocd::ocd_registration::smart_dump ( std::ostream &  out_ = std::clog,
const std::string &  title_ = "",
const std::string &  indent_ = "" 
) const

Smart print.

◆ unregistration()

template<class T >
void datatools::detail::ocd::ocd_registration::unregistration ( const std::string &  class_name_)

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