DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
dunedaq::conffwk::ConfigObjectImpl Class Referenceabstract

Implements database objects. More...

#include <ConfigObjectImpl.hpp>

Inheritance diagram for dunedaq::conffwk::ConfigObjectImpl:
[legend]
Collaboration diagram for dunedaq::conffwk::ConfigObjectImpl:
[legend]

Public Member Functions

 ConfigObjectImpl (ConfigurationImpl *impl, const std::string &id, dunedaq::conffwk::ObjectState state=dunedaq::conffwk::Valid) noexcept
 The constructor stores configuration implementation pointer.
virtual ~ConfigObjectImpl () noexcept
 The virtual destructor.
const std::string & UID () const noexcept
 Method to get database object's unique ID.
const std::string & class_name () const noexcept
 Virtual method to get object's class name.
virtual const std::string contained_in () const =0
 Virtual method to get object's database file name.
virtual void get (const std::string &attribute, bool &value)=0
 Virtual method to read boolean attribute value.
virtual void get (const std::string &attribute, uint8_t &value)=0
 Virtual method to read unsigned char attribute value.
virtual void get (const std::string &attribute, int8_t &value)=0
 Virtual method to read signed char attribute value.
virtual void get (const std::string &attribute, uint16_t &value)=0
 Virtual method to read unsigned short attribute value.
virtual void get (const std::string &attribute, int16_t &value)=0
 Virtual method to read signed short attribute value.
virtual void get (const std::string &attribute, uint32_t &value)=0
 Virtual method to read unsigned long attribute value.
virtual void get (const std::string &attribute, int32_t &value)=0
 Virtual method to read signed long attribute value.
virtual void get (const std::string &attribute, uint64_t &value)=0
 Virtual method to read unsigned 64 bits integer attribute value.
virtual void get (const std::string &attribute, int64_t &value)=0
 Virtual method to read signed 64 bits integer attribute value.
virtual void get (const std::string &attribute, float &value)=0
 Virtual method to read float attribute value.
virtual void get (const std::string &attribute, double &value)=0
 Virtual method to read double attribute value.
virtual void get (const std::string &attribute, std::string &value)=0
 Virtual method to read string attribute value.
virtual void get (const std::string &association, ConfigObject &value)=0
 Virtual method to read relationship single-value.
virtual void get (const std::string &attribute, std::vector< bool > &value)=0
 Virtual method to read vector-of-booleans attribute value.
virtual void get (const std::string &attribute, std::vector< uint8_t > &value)=0
 Virtual method to read vector-of-unsigned-chars attribute value.
virtual void get (const std::string &attribute, std::vector< int8_t > &value)=0
 Virtual method to read vector-of-signed-chars attribute value.
virtual void get (const std::string &attribute, std::vector< uint16_t > &value)=0
 Virtual method to read vector-of-unsigned-shorts attribute value.
virtual void get (const std::string &attribute, std::vector< int16_t > &value)=0
 Virtual method to read vector-of-signed-shorts attribute value.
virtual void get (const std::string &attribute, std::vector< uint32_t > &value)=0
 Virtual method to read vector-of-unsigned-longs attribute value.
virtual void get (const std::string &attribute, std::vector< int32_t > &value)=0
 Virtual method to read vector-of-signed-longs attribute value.
virtual void get (const std::string &attribute, std::vector< uint64_t > &value)=0
 Virtual method to read vector-of-unsigned-64-bits-integers attribute value.
virtual void get (const std::string &attribute, std::vector< int64_t > &value)=0
 Virtual method to read vector-of-signed-64-bits-integers attribute value.
virtual void get (const std::string &attribute, std::vector< float > &value)=0
 Virtual method to read vector-of-floats attribute value.
virtual void get (const std::string &attribute, std::vector< double > &value)=0
 Virtual method to read vector-of-doubles attribute value.
virtual void get (const std::string &attribute, std::vector< std::string > &value)=0
 Virtual method to read vector-of-strings attribute value.
virtual void get (const std::string &association, std::vector< ConfigObject > &value)=0
 Virtual method to read vector-of-conffwk-objects relationship value.
virtual bool rel (const std::string &name, std::vector< ConfigObject > &value)=0
 Virtual method to read any relationship value without throwing an exception if there is no such relationship (return false).
virtual void referenced_by (std::vector< ConfigObject > &value, const std::string &association, bool check_composite_only, unsigned long rlevel, const std::vector< std::string > *rclasses) const =0
 Virtual method to read vector-of-conffwk-object referencing this object.
virtual void set (const std::string &attribute, bool value)=0
 Virtual method to set boolean attribute value.
virtual void set (const std::string &attribute, uint8_t value)=0
 Virtual method to set unsigned char attribute value.
virtual void set (const std::string &attribute, int8_t value)=0
 Virtual method to set signed char attribute value.
virtual void set (const std::string &attribute, uint16_t value)=0
 Virtual method to set unsigned short attribute value.
virtual void set (const std::string &attribute, int16_t value)=0
 Virtual method to set signed short attribute value.
virtual void set (const std::string &attribute, uint32_t value)=0
 Virtual method to set unsigned long attribute value.
virtual void set (const std::string &attribute, int32_t value)=0
 Virtual method to set signed long attribute value.
virtual void set (const std::string &attribute, uint64_t value)=0
 Virtual method to set unsigned 64 bits integer attribute value.
virtual void set (const std::string &attribute, int64_t value)=0
 Virtual method to set signed 64 bits integer attribute value.
virtual void set (const std::string &attribute, float value)=0
 Virtual method to set float attribute value.
virtual void set (const std::string &attribute, double value)=0
 Virtual method to set double attribute value.
virtual void set (const std::string &attribute, const std::string &value)=0
 Virtual method to set string attribute value.
virtual void set_enum (const std::string &attribute, const std::string &value)=0
 Virtual method to set enumeration attribute value.
virtual void set_class (const std::string &attribute, const std::string &value)=0
 Virtual method to set enumeration attribute value.
virtual void set_date (const std::string &attribute, const std::string &value)=0
 Virtual method to set date attribute value.
virtual void set_time (const std::string &attribute, const std::string &value)=0
 Virtual method to set time attribute value.
virtual void set (const std::string &attribute, const std::vector< bool > &value)=0
 Virtual method to read vector-of-booleans attribute value.
virtual void set (const std::string &attribute, const std::vector< uint8_t > &value)=0
 Virtual method to read vector-of-unsigned-chars attribute value.
virtual void set (const std::string &attribute, const std::vector< int8_t > &value)=0
 Virtual method to read vector-of-signed-chars attribute value.
virtual void set (const std::string &attribute, const std::vector< uint16_t > &value)=0
 Virtual method to read vector-of-unsigned-shorts attribute value.
virtual void set (const std::string &attribute, const std::vector< int16_t > &value)=0
 Virtual method to read vector-of-signed-shorts attribute value.
virtual void set (const std::string &attribute, const std::vector< uint32_t > &value)=0
 Virtual method to read vector-of-unsigned-longs attribute value.
virtual void set (const std::string &attribute, const std::vector< int32_t > &value)=0
 Virtual method to read vector-of-signed-longs attribute value.
virtual void set (const std::string &attribute, const std::vector< uint64_t > &value)=0
 Virtual method to read vector-of-unsigned-64-bits-integers attribute value.
virtual void set (const std::string &attribute, const std::vector< int64_t > &value)=0
 Virtual method to read vector-of-signed-64-bits-integers attribute value.
virtual void set (const std::string &attribute, const std::vector< float > &value)=0
 Virtual method to read vector-of-floats attribute value.
virtual void set (const std::string &attribute, const std::vector< double > &value)=0
 Virtual method to read vector-of-doubles attribute value.
virtual void set (const std::string &attribute, const std::vector< std::string > &value)=0
 Virtual method to read vector-of-strings attribute value.
virtual void set_enum (const std::string &attribute, const std::vector< std::string > &value)=0
 Virtual method to read vector-of-enumerations attribute value.
virtual void set_class (const std::string &attribute, const std::vector< std::string > &value)=0
 Virtual method to read vector-of-enumerations attribute value.
virtual void set_date (const std::string &attribute, const std::vector< std::string > &value)=0
 Virtual method to read vector-of-dates attribute value.
virtual void set_time (const std::string &attribute, const std::vector< std::string > &value)=0
 Virtual method to read vector-of-times attribute value.
virtual void set (const std::string &association, const ConfigObject *value, bool skip_non_null_check)=0
 Virtual method to read conffwk-object relationship value.
virtual void set (const std::string &association, const std::vector< const ConfigObject * > &value, bool skip_non_null_check)=0
 Virtual method to read vector-of-conffwk-objects relationship value.
virtual void move (const std::string &at)=0
 Virtual method to move object to a file.
virtual void rename (const std::string &new_id)=0
 Virtual method to change object ID.
virtual void clear () noexcept
 Virtual method to clean resources used by the implementation object.
virtual void reset ()=0
 Virtual method to reset the implementation object from unknown state.
bool is_deleted () const
 Check object and return true if the object has been deleted.

Static Public Member Functions

static ConfigObjectImpldefault_impl () noexcept
 Returns default implementation.

Protected Member Functions

void throw_if_deleted () const

Protected Attributes

ConfigurationImplm_impl
dunedaq::conffwk::ObjectState m_state
std::string m_id
const std::string * m_class_name
std::mutex m_mutex

Private Member Functions

 ConfigObjectImpl ()=delete
void convert (bool &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (uint8_t &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (int8_t &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (uint16_t &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (int16_t &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (uint32_t &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (int32_t &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (uint64_t &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (int64_t &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (float &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (double &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::string &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (ConfigObject &, const ConfigObject &, const std::string &) noexcept
void convert (std::vector< bool > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< uint8_t > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< int8_t > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< uint16_t > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< int16_t > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< uint32_t > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< int32_t > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< uint64_t > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< int64_t > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< float > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< double > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< std::string > &value, const ConfigObject &obj, const std::string &attr_name) noexcept
void convert (std::vector< ConfigObject > &, const ConfigObject &, const std::string &) noexcept

Friends

class ConfigObject
class Configuration
class ConfigurationImpl
class DalObject
class DalRegistry

Detailed Description

Implements database objects.

The class defines several pure virtual methods used to get, set and convert values of object's attributes and relationships.

To create implementation for an arbitrary DBMS technology it is necessary to derive new class from ConfigObjectImpl and to implement all virtual methods.

The methods may throw dunedaq::conffwk::Generic exception in case of an error unless noexcept is explicitly used in their specification.

Definition at line 57 of file ConfigObjectImpl.hpp.

Constructor & Destructor Documentation

◆ ConfigObjectImpl() [1/2]

dunedaq::conffwk::ConfigObjectImpl::ConfigObjectImpl ( ConfigurationImpl * impl,
const std::string & id,
dunedaq::conffwk::ObjectState state = dunedaq::conffwk::Valid )
noexcept

The constructor stores configuration implementation pointer.

Definition at line 111 of file ConfigObjectImpl.cpp.

111 : m_impl (impl), m_state(state), m_id(id), m_class_name(nullptr)
112{
113}
dunedaq::conffwk::ObjectState m_state

◆ ~ConfigObjectImpl()

dunedaq::conffwk::ConfigObjectImpl::~ConfigObjectImpl ( )
virtualnoexcept

The virtual destructor.

Definition at line 115 of file ConfigObjectImpl.cpp.

116{
117}

◆ ConfigObjectImpl() [2/2]

dunedaq::conffwk::ConfigObjectImpl::ConfigObjectImpl ( )
privatedelete

Member Function Documentation

◆ class_name()

const std::string & dunedaq::conffwk::ConfigObjectImpl::class_name ( ) const
inlinenoexcept

Virtual method to get object's class name.

Definition at line 98 of file ConfigObjectImpl.hpp.

99 {
100 return *m_class_name;
101 }

◆ clear()

virtual void dunedaq::conffwk::ConfigObjectImpl::clear ( )
inlinevirtualnoexcept

Virtual method to clean resources used by the implementation object.

Definition at line 313 of file ConfigObjectImpl.hpp.

313{;} // by default nothing to do

◆ contained_in()

virtual const std::string dunedaq::conffwk::ConfigObjectImpl::contained_in ( ) const
pure virtual

Virtual method to get object's database file name.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ convert() [1/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( bool & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 411 of file ConfigurationImpl.cpp.

412{
413 m_impl->m_conf->convert(value, obj, attr_name);
414}
msgpack::object obj

◆ convert() [2/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( ConfigObject & ,
const ConfigObject & ,
const std::string &  )
inlineprivatenoexcept

Definition at line 372 of file ConfigObjectImpl.hpp.

372{;}

◆ convert() [3/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( double & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 471 of file ConfigurationImpl.cpp.

472{
473 m_impl->m_conf->convert(value, obj, attr_name);
474}

◆ convert() [4/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( float & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 465 of file ConfigurationImpl.cpp.

466{
467 m_impl->m_conf->convert(value, obj, attr_name);
468}

◆ convert() [5/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( int16_t & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 435 of file ConfigurationImpl.cpp.

436{
437 m_impl->m_conf->convert(value, obj, attr_name);
438}

◆ convert() [6/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( int32_t & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 447 of file ConfigurationImpl.cpp.

448{
449 m_impl->m_conf->convert(value, obj, attr_name);
450}

◆ convert() [7/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( int64_t & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 459 of file ConfigurationImpl.cpp.

460{
461 m_impl->m_conf->convert(value, obj, attr_name);
462}

◆ convert() [8/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( int8_t & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 423 of file ConfigurationImpl.cpp.

424{
425 m_impl->m_conf->convert(value, obj, attr_name);
426}

◆ convert() [9/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::string & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 477 of file ConfigurationImpl.cpp.

478{
479 m_impl->m_conf->convert(value, obj, attr_name);
480}

◆ convert() [10/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< bool > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 484 of file ConfigurationImpl.cpp.

485{
486 //m_impl->m_conf->convert2(value, obj, attr_name);
487}

◆ convert() [11/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< ConfigObject > & ,
const ConfigObject & ,
const std::string &  )
inlineprivatenoexcept

Definition at line 386 of file ConfigObjectImpl.hpp.

386{;}

◆ convert() [12/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< double > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 544 of file ConfigurationImpl.cpp.

545{
546 m_impl->m_conf->convert2(value, obj, attr_name);
547}

◆ convert() [13/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< float > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 538 of file ConfigurationImpl.cpp.

539{
540 m_impl->m_conf->convert2(value, obj, attr_name);
541}

◆ convert() [14/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< int16_t > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 508 of file ConfigurationImpl.cpp.

509{
510 m_impl->m_conf->convert2(value, obj, attr_name);
511}

◆ convert() [15/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< int32_t > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 520 of file ConfigurationImpl.cpp.

521{
522 m_impl->m_conf->convert2(value, obj, attr_name);
523}

◆ convert() [16/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< int64_t > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 532 of file ConfigurationImpl.cpp.

533{
534 m_impl->m_conf->convert2(value, obj, attr_name);
535}

◆ convert() [17/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< int8_t > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 496 of file ConfigurationImpl.cpp.

497{
498 m_impl->m_conf->convert2(value, obj, attr_name);
499}

◆ convert() [18/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< std::string > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 550 of file ConfigurationImpl.cpp.

551{
552 m_impl->m_conf->convert2(value, obj, attr_name);
553}

◆ convert() [19/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< uint16_t > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 502 of file ConfigurationImpl.cpp.

503{
504 m_impl->m_conf->convert2(value, obj, attr_name);
505}

◆ convert() [20/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< uint32_t > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 514 of file ConfigurationImpl.cpp.

515{
516 m_impl->m_conf->convert2(value, obj, attr_name);
517}

◆ convert() [21/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< uint64_t > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 526 of file ConfigurationImpl.cpp.

527{
528 m_impl->m_conf->convert2(value, obj, attr_name);
529}

◆ convert() [22/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( std::vector< uint8_t > & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 490 of file ConfigurationImpl.cpp.

491{
492 m_impl->m_conf->convert2(value, obj, attr_name);
493}

◆ convert() [23/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( uint16_t & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 429 of file ConfigurationImpl.cpp.

430{
431 m_impl->m_conf->convert(value, obj, attr_name);
432}

◆ convert() [24/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( uint32_t & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 441 of file ConfigurationImpl.cpp.

442{
443 m_impl->m_conf->convert(value, obj, attr_name);
444}

◆ convert() [25/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( uint64_t & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 453 of file ConfigurationImpl.cpp.

454{
455 m_impl->m_conf->convert(value, obj, attr_name);
456}

◆ convert() [26/26]

void dunedaq::conffwk::ConfigObjectImpl::convert ( uint8_t & value,
const ConfigObject & obj,
const std::string & attr_name )
privatenoexcept

Definition at line 417 of file ConfigurationImpl.cpp.

418{
419 m_impl->m_conf->convert(value, obj, attr_name);
420}

◆ default_impl()

ConfigObjectImpl * dunedaq::conffwk::ConfigObjectImpl::default_impl ( )
staticnoexcept

Returns default implementation.

Definition at line 119 of file ConfigObjectImpl.cpp.

120{
121 return new ConfigObjectDefault();
122}

◆ get() [1/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & association,
ConfigObject & value )
pure virtual

Virtual method to read relationship single-value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [2/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & association,
std::vector< ConfigObject > & value )
pure virtual

Virtual method to read vector-of-conffwk-objects relationship value.

Implemented in dunedaq::conffwk::ConfigObjectDefault.

◆ get() [3/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
bool & value )
pure virtual

Virtual method to read boolean attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [4/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
double & value )
pure virtual

Virtual method to read double attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [5/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
float & value )
pure virtual

Virtual method to read float attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [6/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
int16_t & value )
pure virtual

Virtual method to read signed short attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [7/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
int32_t & value )
pure virtual

Virtual method to read signed long attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [8/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
int64_t & value )
pure virtual

Virtual method to read signed 64 bits integer attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [9/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
int8_t & value )
pure virtual

Virtual method to read signed char attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [10/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::string & value )
pure virtual

Virtual method to read string attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [11/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< bool > & value )
pure virtual

Virtual method to read vector-of-booleans attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [12/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< double > & value )
pure virtual

Virtual method to read vector-of-doubles attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [13/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< float > & value )
pure virtual

Virtual method to read vector-of-floats attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [14/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< int16_t > & value )
pure virtual

Virtual method to read vector-of-signed-shorts attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [15/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< int32_t > & value )
pure virtual

Virtual method to read vector-of-signed-longs attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [16/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< int64_t > & value )
pure virtual

Virtual method to read vector-of-signed-64-bits-integers attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [17/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< int8_t > & value )
pure virtual

Virtual method to read vector-of-signed-chars attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [18/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< std::string > & value )
pure virtual

Virtual method to read vector-of-strings attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [19/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< uint16_t > & value )
pure virtual

Virtual method to read vector-of-unsigned-shorts attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [20/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< uint32_t > & value )
pure virtual

Virtual method to read vector-of-unsigned-longs attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [21/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< uint64_t > & value )
pure virtual

Virtual method to read vector-of-unsigned-64-bits-integers attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [22/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
std::vector< uint8_t > & value )
pure virtual

Virtual method to read vector-of-unsigned-chars attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [23/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
uint16_t & value )
pure virtual

Virtual method to read unsigned short attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [24/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
uint32_t & value )
pure virtual

Virtual method to read unsigned long attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [25/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
uint64_t & value )
pure virtual

Virtual method to read unsigned 64 bits integer attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ get() [26/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::get ( const std::string & attribute,
uint8_t & value )
pure virtual

Virtual method to read unsigned char attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ is_deleted()

bool dunedaq::conffwk::ConfigObjectImpl::is_deleted ( ) const
inline

Check object and return true if the object has been deleted.

Definition at line 320 of file ConfigObjectImpl.hpp.

321 {
323 {
324 const_cast<ConfigObjectImpl *>(this)->reset();
325 }
326
328 }
virtual void reset()=0
Virtual method to reset the implementation object from unknown state.
ConfigObjectImpl(ConfigurationImpl *impl, const std::string &id, dunedaq::conffwk::ObjectState state=dunedaq::conffwk::Valid) noexcept
The constructor stores configuration implementation pointer.

◆ move()

virtual void dunedaq::conffwk::ConfigObjectImpl::move ( const std::string & at)
pure virtual

Virtual method to move object to a file.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ referenced_by()

virtual void dunedaq::conffwk::ConfigObjectImpl::referenced_by ( std::vector< ConfigObject > & value,
const std::string & association,
bool check_composite_only,
unsigned long rlevel,
const std::vector< std::string > * rclasses ) const
pure virtual

Virtual method to read vector-of-conffwk-object referencing this object.

Implemented in dunedaq::conffwk::ConfigObjectDefault.

◆ rel()

virtual bool dunedaq::conffwk::ConfigObjectImpl::rel ( const std::string & name,
std::vector< ConfigObject > & value )
pure virtual

Virtual method to read any relationship value without throwing an exception if there is no such relationship (return false).

Implemented in dunedaq::conffwk::ConfigObjectDefault.

◆ rename()

virtual void dunedaq::conffwk::ConfigObjectImpl::rename ( const std::string & new_id)
pure virtual

Virtual method to change object ID.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ reset()

virtual void dunedaq::conffwk::ConfigObjectImpl::reset ( )
pure virtual

Virtual method to reset the implementation object from unknown state.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [1/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & association,
const ConfigObject * value,
bool skip_non_null_check )
pure virtual

Virtual method to read conffwk-object relationship value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [2/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & association,
const std::vector< const ConfigObject * > & value,
bool skip_non_null_check )
pure virtual

Virtual method to read vector-of-conffwk-objects relationship value.

Implemented in dunedaq::conffwk::ConfigObjectDefault.

◆ set() [3/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
bool value )
pure virtual

Virtual method to set boolean attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [4/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::string & value )
pure virtual

Virtual method to set string attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [5/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< bool > & value )
pure virtual

Virtual method to read vector-of-booleans attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [6/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< double > & value )
pure virtual

Virtual method to read vector-of-doubles attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [7/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< float > & value )
pure virtual

Virtual method to read vector-of-floats attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [8/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< int16_t > & value )
pure virtual

Virtual method to read vector-of-signed-shorts attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [9/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< int32_t > & value )
pure virtual

Virtual method to read vector-of-signed-longs attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [10/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< int64_t > & value )
pure virtual

Virtual method to read vector-of-signed-64-bits-integers attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [11/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< int8_t > & value )
pure virtual

Virtual method to read vector-of-signed-chars attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [12/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< std::string > & value )
pure virtual

Virtual method to read vector-of-strings attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [13/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< uint16_t > & value )
pure virtual

Virtual method to read vector-of-unsigned-shorts attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [14/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< uint32_t > & value )
pure virtual

Virtual method to read vector-of-unsigned-longs attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [15/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< uint64_t > & value )
pure virtual

Virtual method to read vector-of-unsigned-64-bits-integers attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [16/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
const std::vector< uint8_t > & value )
pure virtual

Virtual method to read vector-of-unsigned-chars attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [17/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
double value )
pure virtual

Virtual method to set double attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [18/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
float value )
pure virtual

Virtual method to set float attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [19/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
int16_t value )
pure virtual

Virtual method to set signed short attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [20/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
int32_t value )
pure virtual

Virtual method to set signed long attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [21/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
int64_t value )
pure virtual

Virtual method to set signed 64 bits integer attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [22/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
int8_t value )
pure virtual

Virtual method to set signed char attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [23/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
uint16_t value )
pure virtual

Virtual method to set unsigned short attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [24/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
uint32_t value )
pure virtual

Virtual method to set unsigned long attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [25/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
uint64_t value )
pure virtual

Virtual method to set unsigned 64 bits integer attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set() [26/26]

virtual void dunedaq::conffwk::ConfigObjectImpl::set ( const std::string & attribute,
uint8_t value )
pure virtual

Virtual method to set unsigned char attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set_class() [1/2]

virtual void dunedaq::conffwk::ConfigObjectImpl::set_class ( const std::string & attribute,
const std::string & value )
pure virtual

Virtual method to set enumeration attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set_class() [2/2]

virtual void dunedaq::conffwk::ConfigObjectImpl::set_class ( const std::string & attribute,
const std::vector< std::string > & value )
pure virtual

Virtual method to read vector-of-enumerations attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set_date() [1/2]

virtual void dunedaq::conffwk::ConfigObjectImpl::set_date ( const std::string & attribute,
const std::string & value )
pure virtual

Virtual method to set date attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set_date() [2/2]

virtual void dunedaq::conffwk::ConfigObjectImpl::set_date ( const std::string & attribute,
const std::vector< std::string > & value )
pure virtual

Virtual method to read vector-of-dates attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set_enum() [1/2]

virtual void dunedaq::conffwk::ConfigObjectImpl::set_enum ( const std::string & attribute,
const std::string & value )
pure virtual

Virtual method to set enumeration attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set_enum() [2/2]

virtual void dunedaq::conffwk::ConfigObjectImpl::set_enum ( const std::string & attribute,
const std::vector< std::string > & value )
pure virtual

Virtual method to read vector-of-enumerations attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set_time() [1/2]

virtual void dunedaq::conffwk::ConfigObjectImpl::set_time ( const std::string & attribute,
const std::string & value )
pure virtual

Virtual method to set time attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ set_time() [2/2]

virtual void dunedaq::conffwk::ConfigObjectImpl::set_time ( const std::string & attribute,
const std::vector< std::string > & value )
pure virtual

Virtual method to read vector-of-times attribute value.

Implemented in dunedaq::conffwk::ConfigObjectDefault, and dunedaq::oksconflibs::OksConfigObject.

◆ throw_if_deleted()

void dunedaq::conffwk::ConfigObjectImpl::throw_if_deleted ( ) const
inlineprotected

Check state of object and throw exception if it has been deleted

Exceptions
dunedaq::conffwk::DeletedObjectif the object has been deleted

Definition at line 347 of file ConfigObjectImpl.hpp.

348 {
349 if (is_deleted())
350 {
351 throw dunedaq::conffwk::DeletedObject(ERS_HERE, m_class_name->c_str(), m_id.c_str());
352 }
353 }
#define ERS_HERE
bool is_deleted() const
Check object and return true if the object has been deleted.

◆ UID()

const std::string & dunedaq::conffwk::ConfigObjectImpl::UID ( ) const
inlinenoexcept

Method to get database object's unique ID.

Definition at line 90 of file ConfigObjectImpl.hpp.

91 {
92 std::lock_guard<std::mutex> scoped_lock(m_mutex); // be sure no one renames the object
93 return m_id;
94 }

◆ ConfigObject

friend class ConfigObject
friend

Definition at line 59 of file ConfigObjectImpl.hpp.

◆ Configuration

friend class Configuration
friend

Definition at line 60 of file ConfigObjectImpl.hpp.

◆ ConfigurationImpl

friend class ConfigurationImpl
friend

Definition at line 61 of file ConfigObjectImpl.hpp.

◆ DalObject

DalObject
friend

Definition at line 62 of file ConfigObjectImpl.hpp.

◆ DalRegistry

friend class DalRegistry
friend

Definition at line 64 of file ConfigObjectImpl.hpp.

Member Data Documentation

◆ m_class_name

const std::string* dunedaq::conffwk::ConfigObjectImpl::m_class_name
protected

Name of object's class

Definition at line 336 of file ConfigObjectImpl.hpp.

◆ m_id

std::string dunedaq::conffwk::ConfigObjectImpl::m_id
protected

Object ID

Definition at line 335 of file ConfigObjectImpl.hpp.

◆ m_impl

ConfigurationImpl* dunedaq::conffwk::ConfigObjectImpl::m_impl
protected

Pointer to configuration implementation object

Definition at line 333 of file ConfigObjectImpl.hpp.

◆ m_mutex

std::mutex dunedaq::conffwk::ConfigObjectImpl::m_mutex
mutableprotected

Mutex protecting concurrent access to this object

Definition at line 337 of file ConfigObjectImpl.hpp.

◆ m_state

dunedaq::conffwk::ObjectState dunedaq::conffwk::ConfigObjectImpl::m_state
protected

State of the object

Definition at line 334 of file ConfigObjectImpl.hpp.


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