Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | List of all members
datatools::configuration::parameter_physical Class Reference

Physical parameter physical. More...

#include <bayeux/datatools/configuration/parameter_physical.h>

Inheritance diagram for datatools::configuration::parameter_physical:
datatools::enriched_base datatools::i_serializable datatools::i_tree_dumpable

Public Member Functions

virtual bool is_name_valid (const std::string &name_) const
 Check if a name is valid. More...
 
 parameter_physical ()
 Default constructeur. More...
 
 ~parameter_physical ()
 Destructeur. More...
 
void reset ()
 Reset. More...
 
void set (const std::string &name_, const std::string &desc_, const pm_handle_type &parameter_model_handle_)
 Set the physical. More...
 
const parameter_modelget_model () const
 Return the model of the parameter. More...
 
const pm_handle_typeget_model_handle () const
 Return the handle on the model of the parameter. 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...
 
bool has_occurrence () const
 Check occurrence. More...
 
const i_occurrenceget_occurrence () const
 Return the occurrence of the parameter. More...
 
void install_occurrence (const std::string &occurrence_def_)
 Install an occurrence object. More...
 
- Public Member Functions inherited from datatools::enriched_base
 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
 

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

Detailed Description

Physical parameter physical.

Constructor & Destructor Documentation

◆ parameter_physical()

datatools::configuration::parameter_physical::parameter_physical ( )

Default constructeur.

◆ ~parameter_physical()

datatools::configuration::parameter_physical::~parameter_physical ( )

Destructeur.

Member Function Documentation

◆ get_model()

const parameter_model& datatools::configuration::parameter_physical::get_model ( ) const

Return the model of the parameter.

◆ get_model_handle()

const pm_handle_type& datatools::configuration::parameter_physical::get_model_handle ( ) const

Return the handle on the model of the parameter.

◆ get_occurrence()

const i_occurrence& datatools::configuration::parameter_physical::get_occurrence ( ) const

Return the occurrence of the parameter.

◆ has_occurrence()

bool datatools::configuration::parameter_physical::has_occurrence ( ) const

Check occurrence.

◆ install_occurrence()

void datatools::configuration::parameter_physical::install_occurrence ( const std::string &  occurrence_def_)

Install an occurrence object.

◆ is_name_valid()

virtual bool datatools::configuration::parameter_physical::is_name_valid ( const std::string &  name_) const
virtual

Check if a name is valid.

Reimplemented from datatools::enriched_base.

◆ reset()

void datatools::configuration::parameter_physical::reset ( )

Reset.

◆ set()

void datatools::configuration::parameter_physical::set ( const std::string &  name_,
const std::string &  desc_,
const pm_handle_type parameter_model_handle_ 
)

Set the physical.

◆ tree_dump()

virtual void datatools::configuration::parameter_physical::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::i_tree_dumpable.


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