DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | Friends | List of all members
dunedaq::timinglibs::dal::TimingControllerConf Class Reference

#include <TimingControllerConf.hpp>

Inheritance diagram for dunedaq::timinglibs::dal::TimingControllerConf:
[legend]
Collaboration diagram for dunedaq::timinglibs::dal::TimingControllerConf:
[legend]

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the TimingControllerConf object.
 
virtual std::vector< const dunedaq::conffwk::DalObject * > get (const std::string &name, bool upcast_unregistered=true) const
 Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
 
const std::string & get_device () const
 Get "device" attribute value. String of managed device name.
 
void set_device (const std::string &value)
 Set "device" attribute value. String of managed device name.
 
bool get_hardware_state_recovery_enabled () const
 Get "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.
 
void set_hardware_state_recovery_enabled (bool value)
 Set "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.
 
const std::string & get_timing_session_name () const
 Get "timing_session_name" attribute value. Name of managed device timing session.
 
void set_timing_session_name (const std::string &value)
 Set "timing_session_name" attribute value. Name of managed device timing session.
 
uint32_t get_clock_source () const
 Get "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.
 
void set_clock_source (uint32_t value)
 Set "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.
 
const std::string & get_clock_config () const
 Get "clock_config" attribute value. Path of clock config file.
 
void set_clock_config (const std::string &value)
 Set "clock_config" attribute value. Path of clock config file.
 
bool get_soft () const
 Get "soft" attribute value. Soft reset.
 
void set_soft (bool value)
 Set "soft" attribute value. Soft reset.
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the TimingControllerConf object.
 
virtual std::vector< const dunedaq::conffwk::DalObject * > get (const std::string &name, bool upcast_unregistered=true) const
 Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
 
const std::string & get_device () const
 Get "device" attribute value. String of managed device name.
 
void set_device (const std::string &value)
 Set "device" attribute value. String of managed device name.
 
bool get_hardware_state_recovery_enabled () const
 Get "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.
 
void set_hardware_state_recovery_enabled (bool value)
 Set "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.
 
const std::string & get_timing_session_name () const
 Get "timing_session_name" attribute value. Name of managed device timing session.
 
void set_timing_session_name (const std::string &value)
 Set "timing_session_name" attribute value. Name of managed device timing session.
 
uint32_t get_clock_source () const
 Get "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.
 
void set_clock_source (uint32_t value)
 Set "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.
 
const std::string & get_clock_config () const
 Get "clock_config" attribute value. Path of clock config file.
 
void set_clock_config (const std::string &value)
 Set "clock_config" attribute value. Path of clock config file.
 
bool get_soft () const
 Get "soft" attribute value. Soft reset.
 
void set_soft (bool value)
 Set "soft" attribute value. Soft reset.
 
- Public Member Functions inherited from dunedaq::conffwk::DalObject
const std::string & UID () const noexcept
 
const std::string & class_name () const noexcept
 
bool castable (const std::string &target) const noexcept
 
bool castable (const std::string *target) const noexcept
 
template<class TARGET >
const TARGET * cast () const noexcept
 Casts object to different class.
 
std::string full_name () const noexcept
 
const ConfigObject & config_object () const
 
DalRegistry & registry () const noexcept
 
Configuration & configuration () const noexcept
 
void unread ()
 
void set (const ConfigObject &o) noexcept
 
void move (const std::string &at)
 
void rename (const std::string &new_id)
 
void p_hdr (std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
 print object headers
 
std::ostream & print_object (std::ostream &s) const
 print object details
 
void throw_init_ex (dunedaq::conffwk::Exception &ex)
 throw object initialisation exception (i.e.
 

Static Public Member Functions

static const std::string & __get_device_str () noexcept
 
static const std::string & __get_hardware_state_recovery_enabled_str () noexcept
 
static const std::string & __get_timing_session_name_str () noexcept
 
static const std::string & __get_clock_source_str () noexcept
 
static const std::string & __get_clock_config_str () noexcept
 
static const std::string & __get_soft_str () noexcept
 
static const std::string & __get_device_str () noexcept
 
static const std::string & __get_hardware_state_recovery_enabled_str () noexcept
 
static const std::string & __get_timing_session_name_str () noexcept
 
static const std::string & __get_clock_source_str () noexcept
 
static const std::string & __get_clock_config_str () noexcept
 
static const std::string & __get_soft_str () noexcept
 
- Static Public Member Functions inherited from dunedaq::conffwk::DalObject
static void p_null (std::ostream &s)
 print "(null)"
 
static void p_rm (std::ostream &s)
 print "(deleted object)"
 
static void p_error (std::ostream &s, dunedaq::conffwk::Exception &ex)
 print error text
 
static void throw_get_ex (const std::string &what, const std::string &class_name, const DalObject *obj)
 throw exception in generated get method (i.e.
 
static bool is_null (const DalObject *ref) noexcept
 check a pointer on DAL object is null
 

Static Public Attributes

static const std::string & s_class_name
 
static const std::string s_device = "device"
 
static const std::string s_hardware_state_recovery_enabled = "hardware_state_recovery_enabled"
 
static const std::string s_timing_session_name = "timing_session_name"
 
static const std::string s_clock_source = "clock_source"
 
static const std::string s_clock_config = "clock_config"
 
static const std::string s_soft = "soft"
 

Protected Member Functions

 TimingControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~TimingControllerConf () noexcept
 
virtual void init (bool init_children)
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 TimingControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~TimingControllerConf () noexcept
 
virtual void init (bool init_children)
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
- Protected Member Functions inherited from dunedaq::conffwk::DalObject
 DalObject (DalRegistry &db, const ConfigObject &o) noexcept
 
virtual ~DalObject ()
 
void clear () noexcept
 
void check () const
 
bool is_deleted () const
 
void increment_created () noexcept
 
void increment_read () noexcept
 
void check_init () const
 Check and initialize object if necessary.
 
template<typename T >
void _set_object (const std::string &name, const T *value)
 Helper method for generated set single-value relationship methods.
 
template<typename T >
void _set_objects (const std::string &name, const std::vector< const T * > &value)
 Helper method for generated set multi-value relationship methods.
 
bool get_rel_objects (const std::string &name, bool upcast_unregistered, std::vector< const DalObject * > &objs) const
 Read relationship values as DAL objects using DAL factory.
 
bool get_algo_objects (const std::string &name, std::vector< const DalObject * > &objs) const
 Run algorithm and return result as DAL objects using DAL factory.
 

Private Attributes

std::string m_device
 
bool m_hardware_state_recovery_enabled
 
std::string m_timing_session_name
 
uint32_t m_clock_source
 
std::string m_clock_config
 
bool m_soft
 

Friends

class conffwk::Configuration
 
class conffwk::DalObject
 
class conffwk::DalFactory
 
class conffwk::DalRegistry
 

Additional Inherited Members

- Protected Attributes inherited from dunedaq::conffwk::DalObject
std::mutex m_mutex
 Used to protect changes of DAL object.
 
bool p_was_read
 is true, if the object was read
 
DalRegistry & p_registry
 Configuration object.
 
ConfigObject p_obj
 Config object used by given template object.
 
std::string p_UID
 Is used for template objects (see dqm_conffwk)
 

Detailed Description

Definition at line 21 of file TimingControllerConf.hpp.

Constructor & Destructor Documentation

◆ TimingControllerConf() [1/2]

dunedaq::timinglibs::dal::TimingControllerConf::TimingControllerConf ( conffwk::DalRegistry & db,
const conffwk::ConfigObject & obj )
protectednoexcept

Definition at line 27 of file TimingControllerConf.cpp.

27 :
28 dunedaq::conffwk::DalObject(db, o)
29 {
30 ;
31 }
dunedaq::conffwk::DalObject
The base class for any generated DAL object.
Definition DalObject.hpp:45

◆ ~TimingControllerConf() [1/2]

dunedaq::timinglibs::dal::TimingControllerConf::~TimingControllerConf ( )
protectedvirtualnoexcept

Definition at line 79 of file TimingControllerConf.cpp.

80 {
81 }

◆ TimingControllerConf() [2/2]

dunedaq::timinglibs::dal::TimingControllerConf::TimingControllerConf ( conffwk::DalRegistry & db,
const conffwk::ConfigObject & obj )
protectednoexcept

◆ ~TimingControllerConf() [2/2]

virtual dunedaq::timinglibs::dal::TimingControllerConf::~TimingControllerConf ( )
protectedvirtualnoexcept

Member Function Documentation

◆ __get_clock_config_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_clock_config_str ( )
inlinestaticnoexcept

Definition at line 95 of file TimingControllerConf.hpp.

95{ return s_clock_config; }

◆ __get_clock_config_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_clock_config_str ( )
inlinestaticnoexcept

Definition at line 95 of file TimingControllerConf.hpp.

95{ return s_clock_config; }

◆ __get_clock_source_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_clock_source_str ( )
inlinestaticnoexcept

Definition at line 94 of file TimingControllerConf.hpp.

94{ return s_clock_source; }

◆ __get_clock_source_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_clock_source_str ( )
inlinestaticnoexcept

Definition at line 94 of file TimingControllerConf.hpp.

94{ return s_clock_source; }

◆ __get_device_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_device_str ( )
inlinestaticnoexcept

Definition at line 91 of file TimingControllerConf.hpp.

91{ return s_device; }

◆ __get_device_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_device_str ( )
inlinestaticnoexcept

Definition at line 91 of file TimingControllerConf.hpp.

91{ return s_device; }

◆ __get_hardware_state_recovery_enabled_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_hardware_state_recovery_enabled_str ( )
inlinestaticnoexcept

Definition at line 92 of file TimingControllerConf.hpp.

92{ return s_hardware_state_recovery_enabled; }

◆ __get_hardware_state_recovery_enabled_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_hardware_state_recovery_enabled_str ( )
inlinestaticnoexcept

Definition at line 92 of file TimingControllerConf.hpp.

92{ return s_hardware_state_recovery_enabled; }

◆ __get_soft_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_soft_str ( )
inlinestaticnoexcept

Definition at line 96 of file TimingControllerConf.hpp.

96{ return s_soft; }

◆ __get_soft_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_soft_str ( )
inlinestaticnoexcept

Definition at line 96 of file TimingControllerConf.hpp.

96{ return s_soft; }

◆ __get_timing_session_name_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_timing_session_name_str ( )
inlinestaticnoexcept

Definition at line 93 of file TimingControllerConf.hpp.

93{ return s_timing_session_name; }

◆ __get_timing_session_name_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::__get_timing_session_name_str ( )
inlinestaticnoexcept

Definition at line 93 of file TimingControllerConf.hpp.

93{ return s_timing_session_name; }

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::timinglibs::dal::TimingControllerConf::get ( const std::string & name,
bool upcast_unregistered = true ) const
virtual

Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

Parameters are:

Parameters
namename of the relationship or algorithm
Returns
value of relationship or result of algorithm
Exceptions
std::exceptionif there is no relationship or algorithm with such name in this and base classes

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingMasterControllerConf, and dunedaq::timinglibs::dal::TimingMasterControllerConf.

Definition at line 83 of file TimingControllerConf.cpp.

84 {
85 std::vector<const dunedaq::conffwk::DalObject *> vec;
86
87 if (!get(name, vec, upcast_unregistered, true))
88 throw_get_ex(name, s_class_name, this);
89
90 return vec;
91 }
dunedaq::conffwk::DalObject::throw_get_ex
static void throw_get_ex(const std::string &what, const std::string &class_name, const DalObject *obj)
throw exception in generated get method (i.e.
Definition DalObject.cpp:82
dunedaq::timinglibs::dal::TimingControllerConf::get
virtual std::vector< const dunedaq::conffwk::DalObject * > get(const std::string &name, bool upcast_unregistered=true) const
Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject...
Definition TimingControllerConf.cpp:83

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::timinglibs::dal::TimingControllerConf::get ( const std::string & name,
bool upcast_unregistered = true ) const
virtual

Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

Parameters are:

Parameters
namename of the relationship or algorithm
Returns
value of relationship or result of algorithm
Exceptions
std::exceptionif there is no relationship or algorithm with such name in this and base classes

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingMasterControllerConf, and dunedaq::timinglibs::dal::TimingMasterControllerConf.

◆ get() [3/4]

bool dunedaq::timinglibs::dal::TimingControllerConf::get ( const std::string & name,
std::vector< const dunedaq::conffwk::DalObject * > & vec,
bool upcast_unregistered,
bool first_call ) const
protected

Definition at line 93 of file TimingControllerConf.cpp.

94 {
95 if (first_call)
96 {
97 std::lock_guard scoped_lock(m_mutex);
98
99 check();
100 check_init();
101
102 if (get_rel_objects(name, upcast_unregistered, vec))
103 return true;
104 }
105
106 if (first_call)
107 return get_algo_objects(name, vec);
108
109 return false;
110 }
dunedaq::conffwk::DalObject::get_rel_objects
bool get_rel_objects(const std::string &name, bool upcast_unregistered, std::vector< const DalObject * > &objs) const
Read relationship values as DAL objects using DAL factory.
Definition DalObject.cpp:8
dunedaq::conffwk::DalObject::m_mutex
std::mutex m_mutex
Used to protect changes of DAL object.
Definition DalObject.hpp:108
dunedaq::conffwk::DalObject::get_algo_objects
bool get_algo_objects(const std::string &name, std::vector< const DalObject * > &objs) const
Run algorithm and return result as DAL objects using DAL factory.
Definition DalObject.cpp:25
dunedaq::conffwk::DalObject::check_init
void check_init() const
Check and initialize object if necessary.
Definition DalObject.hpp:405

◆ get() [4/4]

bool dunedaq::timinglibs::dal::TimingControllerConf::get ( const std::string & name,
std::vector< const dunedaq::conffwk::DalObject * > & vec,
bool upcast_unregistered,
bool first_call ) const
protected

◆ get_clock_config() [1/2]

const std::string & dunedaq::timinglibs::dal::TimingControllerConf::get_clock_config ( ) const
inline

Get "clock_config" attribute value. Path of clock config file.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 239 of file TimingControllerConf.hpp.

240 {
241 std::lock_guard scoped_lock(m_mutex);
242 check();
243 check_init();
244 return m_clock_config;
245 }

◆ get_clock_config() [2/2]

const std::string & dunedaq::timinglibs::dal::TimingControllerConf::get_clock_config ( ) const
inline

Get "clock_config" attribute value. Path of clock config file.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 239 of file TimingControllerConf.hpp.

240 {
241 std::lock_guard scoped_lock(m_mutex);
242 check();
243 check_init();
244 return m_clock_config;
245 }

◆ get_clock_source() [1/2]

uint32_t dunedaq::timinglibs::dal::TimingControllerConf::get_clock_source ( ) const
inline

Get "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 206 of file TimingControllerConf.hpp.

207 {
208 std::lock_guard scoped_lock(m_mutex);
209 check();
210 check_init();
211 return m_clock_source;
212 }

◆ get_clock_source() [2/2]

uint32_t dunedaq::timinglibs::dal::TimingControllerConf::get_clock_source ( ) const
inline

Get "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 206 of file TimingControllerConf.hpp.

207 {
208 std::lock_guard scoped_lock(m_mutex);
209 check();
210 check_init();
211 return m_clock_source;
212 }

◆ get_device() [1/2]

const std::string & dunedaq::timinglibs::dal::TimingControllerConf::get_device ( ) const
inline

Get "device" attribute value. String of managed device name.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 107 of file TimingControllerConf.hpp.

108 {
109 std::lock_guard scoped_lock(m_mutex);
110 check();
111 check_init();
112 return m_device;
113 }

◆ get_device() [2/2]

const std::string & dunedaq::timinglibs::dal::TimingControllerConf::get_device ( ) const
inline

Get "device" attribute value. String of managed device name.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 107 of file TimingControllerConf.hpp.

108 {
109 std::lock_guard scoped_lock(m_mutex);
110 check();
111 check_init();
112 return m_device;
113 }

◆ get_hardware_state_recovery_enabled() [1/2]

bool dunedaq::timinglibs::dal::TimingControllerConf::get_hardware_state_recovery_enabled ( ) const
inline

Get "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 140 of file TimingControllerConf.hpp.

141 {
142 std::lock_guard scoped_lock(m_mutex);
143 check();
144 check_init();
145 return m_hardware_state_recovery_enabled;
146 }

◆ get_hardware_state_recovery_enabled() [2/2]

bool dunedaq::timinglibs::dal::TimingControllerConf::get_hardware_state_recovery_enabled ( ) const
inline

Get "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 140 of file TimingControllerConf.hpp.

141 {
142 std::lock_guard scoped_lock(m_mutex);
143 check();
144 check_init();
145 return m_hardware_state_recovery_enabled;
146 }

◆ get_soft() [1/2]

bool dunedaq::timinglibs::dal::TimingControllerConf::get_soft ( ) const
inline

Get "soft" attribute value. Soft reset.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 272 of file TimingControllerConf.hpp.

273 {
274 std::lock_guard scoped_lock(m_mutex);
275 check();
276 check_init();
277 return m_soft;
278 }

◆ get_soft() [2/2]

bool dunedaq::timinglibs::dal::TimingControllerConf::get_soft ( ) const
inline

Get "soft" attribute value. Soft reset.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 272 of file TimingControllerConf.hpp.

273 {
274 std::lock_guard scoped_lock(m_mutex);
275 check();
276 check_init();
277 return m_soft;
278 }

◆ get_timing_session_name() [1/2]

const std::string & dunedaq::timinglibs::dal::TimingControllerConf::get_timing_session_name ( ) const
inline

Get "timing_session_name" attribute value. Name of managed device timing session.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 173 of file TimingControllerConf.hpp.

174 {
175 std::lock_guard scoped_lock(m_mutex);
176 check();
177 check_init();
178 return m_timing_session_name;
179 }

◆ get_timing_session_name() [2/2]

const std::string & dunedaq::timinglibs::dal::TimingControllerConf::get_timing_session_name ( ) const
inline

Get "timing_session_name" attribute value. Name of managed device timing session.

Returns
the attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 173 of file TimingControllerConf.hpp.

174 {
175 std::lock_guard scoped_lock(m_mutex);
176 check();
177 check_init();
178 return m_timing_session_name;
179 }

◆ init() [1/2]

void dunedaq::timinglibs::dal::TimingControllerConf::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingMasterControllerConf, and dunedaq::timinglibs::dal::TimingMasterControllerConf.

Definition at line 60 of file TimingControllerConf.cpp.

61 {
62 p_was_read = true;
63 increment_read();
64 TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
65
66 try {
67 p_obj.get(s_device, m_device);
68 p_obj.get(s_hardware_state_recovery_enabled, m_hardware_state_recovery_enabled);
69 p_obj.get(s_timing_session_name, m_timing_session_name);
70 p_obj.get(s_clock_source, m_clock_source);
71 p_obj.get(s_clock_config, m_clock_config);
72 p_obj.get(s_soft, m_soft);
73 }
74 catch (dunedaq::conffwk::Exception & ex) {
75 throw_init_ex(ex);
76 }
77 }
dunedaq::conffwk::ConfigObject::get
void get(const std::string &name, T &value)
Get value of object's attribute or relationship.
Definition ConfigObject.hpp:278
dunedaq::conffwk::DalObject::throw_init_ex
void throw_init_ex(dunedaq::conffwk::Exception &ex)
throw object initialisation exception (i.e.
Definition DalObject.cpp:74
dunedaq::conffwk::DalObject::increment_read
void increment_read() noexcept
Definition DalObject.hpp:352
dunedaq::conffwk::DalObject::p_was_read
bool p_was_read
is true, if the object was read
Definition DalObject.hpp:111
dunedaq::conffwk::DalObject::p_obj
ConfigObject p_obj
Config object used by given template object.
Definition DalObject.hpp:117
TLOG_DEBUG
#define TLOG_DEBUG(lvl,...)
Definition Logging.hpp:112

◆ init() [2/2]

virtual void dunedaq::timinglibs::dal::TimingControllerConf::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingMasterControllerConf, and dunedaq::timinglibs::dal::TimingMasterControllerConf.

◆ print() [1/2]

void dunedaq::timinglibs::dal::TimingControllerConf::print ( unsigned int offset,
bool print_header,
std::ostream & s ) const
virtual

Print details of the TimingControllerConf object.

Parameters are:

Parameters
offsetnumber of spaces to shift object right (useful to print nested objects)
print_headerif false, do not print object header (to print attributes of base classes)
soutput stream

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingMasterControllerConf, and dunedaq::timinglibs::dal::TimingMasterControllerConf.

Definition at line 34 of file TimingControllerConf.cpp.

35 {
36 check_init();
37
38 try {
39 const std::string str(indent+2, ' ');
40
41 if (print_header)
42 p_hdr(s, indent, s_class_name, "dunedaq::timinglibs::dal");
43
44
45 // print direct attributes
46
47 dunedaq::conffwk::p_sv_attr(s, str, s_device, m_device);
48 dunedaq::conffwk::p_sv_attr(s, str, s_hardware_state_recovery_enabled, m_hardware_state_recovery_enabled);
49 dunedaq::conffwk::p_sv_attr(s, str, s_timing_session_name, m_timing_session_name);
50 dunedaq::conffwk::p_sv_attr(s, str, s_clock_source, m_clock_source);
51 dunedaq::conffwk::p_sv_attr(s, str, s_clock_config, m_clock_config);
52 dunedaq::conffwk::p_sv_attr(s, str, s_soft, m_soft);
53 }
54 catch (dunedaq::conffwk::Exception & ex) {
55 dunedaq::conffwk::DalObject::p_error(s, ex);
56 }
57 }
dunedaq::conffwk::DalObject::p_hdr
void p_hdr(std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
print object headers
Definition DalObject.cpp:65
dunedaq::conffwk::DalObject::p_error
static void p_error(std::ostream &s, dunedaq::conffwk::Exception &ex)
print error text
Definition DalObject.cpp:59
dunedaq::conffwk::p_sv_attr
void p_sv_attr(std::ostream &s, const std::string &str, const std::string &name, const T &val) noexcept
print single-value attribute
Definition DalObjectPrint.hpp:61

◆ print() [2/2]

virtual void dunedaq::timinglibs::dal::TimingControllerConf::print ( unsigned int offset,
bool print_header,
std::ostream & s ) const
virtual

Print details of the TimingControllerConf object.

Parameters are:

Parameters
offsetnumber of spaces to shift object right (useful to print nested objects)
print_headerif false, do not print object header (to print attributes of base classes)
soutput stream

Implements dunedaq::conffwk::DalObject.

Reimplemented in dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::hsilibs::dal::HSIControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingEndpointControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingFanoutControllerConf, dunedaq::timinglibs::dal::TimingMasterControllerConf, and dunedaq::timinglibs::dal::TimingMasterControllerConf.

◆ set_clock_config() [1/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_clock_config ( const std::string & value)
inline

Set "clock_config" attribute value. Path of clock config file.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 255 of file TimingControllerConf.hpp.

256 {
257 std::lock_guard scoped_lock(m_mutex);
258 check();
259 clear();
260 p_obj.set_by_ref(s_clock_config, value);
261 }
dunedaq::conffwk::ConfigObject::set_by_ref
void set_by_ref(const std::string &name, T &value)
Set attribute value.
Definition ConfigObject.hpp:412

◆ set_clock_config() [2/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_clock_config ( const std::string & value)
inline

Set "clock_config" attribute value. Path of clock config file.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 255 of file TimingControllerConf.hpp.

256 {
257 std::lock_guard scoped_lock(m_mutex);
258 check();
259 clear();
260 p_obj.set_by_ref(s_clock_config, value);
261 }

◆ set_clock_source() [1/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_clock_source ( uint32_t value)
inline

Set "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 222 of file TimingControllerConf.hpp.

223 {
224 std::lock_guard scoped_lock(m_mutex);
225 check();
226 clear();
227 p_obj.set_by_val(s_clock_source, value);
228 }
dunedaq::conffwk::ConfigObject::set_by_val
void set_by_val(const std::string &name, T value)
Set attribute value.
Definition ConfigObject.hpp:391

◆ set_clock_source() [2/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_clock_source ( uint32_t value)
inline

Set "clock_source" attribute value. Clock source, 0 for PLL input 0, 1 for in 1, etc.. 255 for free run mode.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 222 of file TimingControllerConf.hpp.

223 {
224 std::lock_guard scoped_lock(m_mutex);
225 check();
226 clear();
227 p_obj.set_by_val(s_clock_source, value);
228 }

◆ set_device() [1/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_device ( const std::string & value)
inline

Set "device" attribute value. String of managed device name.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 123 of file TimingControllerConf.hpp.

124 {
125 std::lock_guard scoped_lock(m_mutex);
126 check();
127 clear();
128 p_obj.set_by_ref(s_device, value);
129 }

◆ set_device() [2/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_device ( const std::string & value)
inline

Set "device" attribute value. String of managed device name.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 123 of file TimingControllerConf.hpp.

124 {
125 std::lock_guard scoped_lock(m_mutex);
126 check();
127 clear();
128 p_obj.set_by_ref(s_device, value);
129 }

◆ set_hardware_state_recovery_enabled() [1/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_hardware_state_recovery_enabled ( bool value)
inline

Set "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 156 of file TimingControllerConf.hpp.

157 {
158 std::lock_guard scoped_lock(m_mutex);
159 check();
160 clear();
161 p_obj.set_by_val(s_hardware_state_recovery_enabled, value);
162 }

◆ set_hardware_state_recovery_enabled() [2/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_hardware_state_recovery_enabled ( bool value)
inline

Set "hardware_state_recovery_enabled" attribute value. Control flag for hardware state recovery.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 156 of file TimingControllerConf.hpp.

157 {
158 std::lock_guard scoped_lock(m_mutex);
159 check();
160 clear();
161 p_obj.set_by_val(s_hardware_state_recovery_enabled, value);
162 }

◆ set_soft() [1/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_soft ( bool value)
inline

Set "soft" attribute value. Soft reset.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 288 of file TimingControllerConf.hpp.

289 {
290 std::lock_guard scoped_lock(m_mutex);
291 check();
292 clear();
293 p_obj.set_by_val(s_soft, value);
294 }

◆ set_soft() [2/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_soft ( bool value)
inline

Set "soft" attribute value. Soft reset.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 288 of file TimingControllerConf.hpp.

289 {
290 std::lock_guard scoped_lock(m_mutex);
291 check();
292 clear();
293 p_obj.set_by_val(s_soft, value);
294 }

◆ set_timing_session_name() [1/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_timing_session_name ( const std::string & value)
inline

Set "timing_session_name" attribute value. Name of managed device timing session.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 189 of file TimingControllerConf.hpp.

190 {
191 std::lock_guard scoped_lock(m_mutex);
192 check();
193 clear();
194 p_obj.set_by_ref(s_timing_session_name, value);
195 }

◆ set_timing_session_name() [2/2]

void dunedaq::timinglibs::dal::TimingControllerConf::set_timing_session_name ( const std::string & value)
inline

Set "timing_session_name" attribute value. Name of managed device timing session.

Parameters
valuenew attribute value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 189 of file TimingControllerConf.hpp.

190 {
191 std::lock_guard scoped_lock(m_mutex);
192 check();
193 clear();
194 p_obj.set_by_ref(s_timing_session_name, value);
195 }

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration
friend

Definition at line 23 of file TimingControllerConf.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 25 of file TimingControllerConf.hpp.

◆ conffwk::DalObject

conffwk::DalObject
friend

Definition at line 24 of file TimingControllerConf.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry
friend

Definition at line 26 of file TimingControllerConf.hpp.

Member Data Documentation

◆ m_clock_config

std::string dunedaq::timinglibs::dal::TimingControllerConf::m_clock_config
private

Definition at line 76 of file TimingControllerConf.hpp.

◆ m_clock_source

uint32_t dunedaq::timinglibs::dal::TimingControllerConf::m_clock_source
private

Definition at line 75 of file TimingControllerConf.hpp.

◆ m_device

std::string dunedaq::timinglibs::dal::TimingControllerConf::m_device
private

Definition at line 72 of file TimingControllerConf.hpp.

◆ m_hardware_state_recovery_enabled

bool dunedaq::timinglibs::dal::TimingControllerConf::m_hardware_state_recovery_enabled
private

Definition at line 73 of file TimingControllerConf.hpp.

◆ m_soft

bool dunedaq::timinglibs::dal::TimingControllerConf::m_soft
private

Definition at line 77 of file TimingControllerConf.hpp.

◆ m_timing_session_name

std::string dunedaq::timinglibs::dal::TimingControllerConf::m_timing_session_name
private

Definition at line 74 of file TimingControllerConf.hpp.

◆ s_class_name

static const std::string & dunedaq::timinglibs::dal::TimingControllerConf::s_class_name
static

The name of the configuration class.

Definition at line 38 of file TimingControllerConf.hpp.

◆ s_clock_config

static const std::string dunedaq::timinglibs::dal::TimingControllerConf::s_clock_config = "clock_config"
inlinestatic

Definition at line 88 of file TimingControllerConf.hpp.

◆ s_clock_source

static const std::string dunedaq::timinglibs::dal::TimingControllerConf::s_clock_source = "clock_source"
inlinestatic

Definition at line 87 of file TimingControllerConf.hpp.

◆ s_device

static const std::string dunedaq::timinglibs::dal::TimingControllerConf::s_device = "device"
inlinestatic

Definition at line 84 of file TimingControllerConf.hpp.

◆ s_hardware_state_recovery_enabled

static const std::string dunedaq::timinglibs::dal::TimingControllerConf::s_hardware_state_recovery_enabled = "hardware_state_recovery_enabled"
inlinestatic

Definition at line 85 of file TimingControllerConf.hpp.

◆ s_soft

static const std::string dunedaq::timinglibs::dal::TimingControllerConf::s_soft = "soft"
inlinestatic

Definition at line 89 of file TimingControllerConf.hpp.

◆ s_timing_session_name

static const std::string dunedaq::timinglibs::dal::TimingControllerConf::s_timing_session_name = "timing_session_name"
inlinestatic

Definition at line 86 of file TimingControllerConf.hpp.

The documentation for this class was generated from the following files:
Generated on Sat Jun 28 2025 for DUNE-DAQ by doxygen 1.12.0