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

An object that describes the way an object of a given class can be configured through properties. More...

#include <bayeux/datatools/object_configuration_description.h>

Public Types

enum  po_flags_type { po_none = 0, po_no_config = 0x1, po_no_title = 0x2 }
 Print option flags. More...
 
enum  sgo_flags_type { sgo_none = 0, sgo_no_add_infos = 0x1, sgo_no_config_hints = 0x2, sgo_minimal = sgo_no_add_infos | sgo_no_config_hints }
 Skeleton/sample generator option flags. More...
 
typedef std::vector< configuration_property_description > cpd_col_type
 

Public Member Functions

bool is_available () const
 
 object_configuration_description ()
 
object_configuration_description & set_class_name (const std::string &)
 
object_configuration_description & set_class_description (const std::string &)
 
object_configuration_description & set_class_documentation (const std::string &)
 
object_configuration_description & set_class_library (const std::string &)
 
object_configuration_description & set_configuration_hints (const std::string &)
 
object_configuration_description & set_validation_support (bool)
 
const std::string & get_class_name () const
 
const std::string & get_class_description () const
 
const std::string & get_class_documentation () const
 
const std::string & get_class_library () const
 
void add_group (const std::string &group_)
 
const std::set< std::string > & get_groups () const
 
bool has_class_description () const
 
bool has_class_library () const
 
bool has_class_documentation () const
 
const std::string & get_configuration_hints () const
 
bool has_configuration_hints () const
 
bool has_validation_support () const
 
void print (std::ostream &out_, const std::string &indent_="", uint32_t po_flags_=0) const
 
unsigned int get_number_of_documented_properties () const
 
const configuration_property_description & get_configuration_property_info (int i_) const
 
configuration_property_description & add_configuration_property_info ()
 
configuration_property_description & add_property_info ()
 
unsigned int get_number_of_examples () const
 
const std::string & get_example (int) const
 
void add_example (const std::string &example_)
 
bool validate (const datatools::properties &config_, std::string &error_message_) const
 Check the validity of a container of properties with respect to the OCD description. More...
 
void generate_sample_configuration (std::ostream &out_, const std::string &topic_="", uint32_t sgo_flags_=0) const
 Generate a sample configuration stream. More...
 
bool is_locked () const
 Check the lock flag. More...
 
void lock ()
 Lock the object. More...
 
void dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="") const
 Raw print. More...
 

Protected Member Functions

void _generate_static_property (const configuration_property_description &cpd_, properties &props_) const
 
bool _validate_static (const configuration_property_description &cpd_, const properties &config_, std::string &error_message_) const
 
bool _validate_traits (const configuration_property_description &cpd_, const properties &config_, std::string &error_message_) const
 

Detailed Description

An object that describes the way an object of a given class can be configured through properties.

Member Typedef Documentation

◆ cpd_col_type

typedef std::vector<configuration_property_description> datatools::object_configuration_description::cpd_col_type

Member Enumeration Documentation

◆ po_flags_type

enum datatools::object_configuration_description::po_flags_type

Print option flags.

Enumerator
po_none 
po_no_config 
po_no_title 

◆ sgo_flags_type

enum datatools::object_configuration_description::sgo_flags_type

Skeleton/sample generator option flags.

Enumerator
sgo_none 
sgo_no_add_infos 
sgo_no_config_hints 
sgo_minimal 

Constructor & Destructor Documentation

◆ object_configuration_description()

datatools::object_configuration_description::object_configuration_description ( )

Member Function Documentation

◆ _generate_static_property()

void datatools::object_configuration_description::_generate_static_property ( const configuration_property_description &  cpd_,
properties &  props_ 
) const
protected

◆ _validate_static()

bool datatools::object_configuration_description::_validate_static ( const configuration_property_description &  cpd_,
const properties &  config_,
std::string &  error_message_ 
) const
protected

◆ _validate_traits()

bool datatools::object_configuration_description::_validate_traits ( const configuration_property_description &  cpd_,
const properties &  config_,
std::string &  error_message_ 
) const
protected

◆ add_configuration_property_info()

configuration_property_description& datatools::object_configuration_description::add_configuration_property_info ( )

◆ add_example()

void datatools::object_configuration_description::add_example ( const std::string &  example_)

◆ add_group()

void datatools::object_configuration_description::add_group ( const std::string &  group_)

◆ add_property_info()

configuration_property_description& datatools::object_configuration_description::add_property_info ( )
Deprecated:

◆ dump()

void datatools::object_configuration_description::dump ( std::ostream &  out_ = std::clog,
const std::string &  title_ = "",
const std::string &  indent_ = "" 
) const

Raw print.

◆ generate_sample_configuration()

void datatools::object_configuration_description::generate_sample_configuration ( std::ostream &  out_,
const std::string &  topic_ = "",
uint32_t  sgo_flags_ = 0 
) const

Generate a sample configuration stream.

◆ get_class_description()

const std::string& datatools::object_configuration_description::get_class_description ( ) const

◆ get_class_documentation()

const std::string& datatools::object_configuration_description::get_class_documentation ( ) const

◆ get_class_library()

const std::string& datatools::object_configuration_description::get_class_library ( ) const

◆ get_class_name()

const std::string& datatools::object_configuration_description::get_class_name ( ) const

◆ get_configuration_hints()

const std::string& datatools::object_configuration_description::get_configuration_hints ( ) const

◆ get_configuration_property_info()

const configuration_property_description& datatools::object_configuration_description::get_configuration_property_info ( int  i_) const

◆ get_example()

const std::string& datatools::object_configuration_description::get_example ( int  ) const

◆ get_groups()

const std::set<std::string>& datatools::object_configuration_description::get_groups ( ) const

◆ get_number_of_documented_properties()

unsigned int datatools::object_configuration_description::get_number_of_documented_properties ( ) const

◆ get_number_of_examples()

unsigned int datatools::object_configuration_description::get_number_of_examples ( ) const

◆ has_class_description()

bool datatools::object_configuration_description::has_class_description ( ) const

◆ has_class_documentation()

bool datatools::object_configuration_description::has_class_documentation ( ) const

◆ has_class_library()

bool datatools::object_configuration_description::has_class_library ( ) const

◆ has_configuration_hints()

bool datatools::object_configuration_description::has_configuration_hints ( ) const

◆ has_validation_support()

bool datatools::object_configuration_description::has_validation_support ( ) const

◆ is_available()

bool datatools::object_configuration_description::is_available ( ) const

◆ is_locked()

bool datatools::object_configuration_description::is_locked ( ) const

Check the lock flag.

◆ lock()

void datatools::object_configuration_description::lock ( )

Lock the object.

◆ print()

void datatools::object_configuration_description::print ( std::ostream &  out_,
const std::string &  indent_ = "",
uint32_t  po_flags_ = 0 
) const

◆ set_class_description()

object_configuration_description& datatools::object_configuration_description::set_class_description ( const std::string &  )

◆ set_class_documentation()

object_configuration_description& datatools::object_configuration_description::set_class_documentation ( const std::string &  )

◆ set_class_library()

object_configuration_description& datatools::object_configuration_description::set_class_library ( const std::string &  )

◆ set_class_name()

object_configuration_description& datatools::object_configuration_description::set_class_name ( const std::string &  )

◆ set_configuration_hints()

object_configuration_description& datatools::object_configuration_description::set_configuration_hints ( const std::string &  )

◆ set_validation_support()

object_configuration_description& datatools::object_configuration_description::set_validation_support ( bool  )

◆ validate()

bool datatools::object_configuration_description::validate ( const datatools::properties &  config_,
std::string &  error_message_ 
) const

Check the validity of a container of properties with respect to the OCD description.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.15