DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
dunedaq::timinglibs::dal::TimingMasterControllerConf Class Reference

#include <TimingMasterControllerConf.hpp>

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

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the TimingMasterControllerConf 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.
 
uint32_t get_timestamp_source () const
 Get "timestamp_source" attribute value. TS source, 0 for upstream, 1 for software, 2 for mixed.
 
void set_timestamp_source (uint32_t value)
 Set "timestamp_source" attribute value. TS source, 0 for upstream, 1 for software, 2 for mixed.
 
uint32_t get_endpoint_scan_period () const
 Get "endpoint_scan_period" attribute value. Period between endpoint scans. 0 for disabled.
 
void set_endpoint_scan_period (uint32_t value)
 Set "endpoint_scan_period" attribute value. Period between endpoint scans. 0 for disabled.
 
const std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > & get_monitored_endpoints () const
 Get "monitored_endpoints" relationship value. List of monitored endpoint locations.
 
void set_monitored_endpoints (const std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > &value)
 Set "monitored_endpoints" relationship value. List of monitored endpoint locations.
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the TimingMasterControllerConf 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.
 
uint32_t get_timestamp_source () const
 Get "timestamp_source" attribute value. TS source, 0 for upstream, 1 for software, 2 for mixed.
 
void set_timestamp_source (uint32_t value)
 Set "timestamp_source" attribute value. TS source, 0 for upstream, 1 for software, 2 for mixed.
 
uint32_t get_endpoint_scan_period () const
 Get "endpoint_scan_period" attribute value. Period between endpoint scans. 0 for disabled.
 
void set_endpoint_scan_period (uint32_t value)
 Set "endpoint_scan_period" attribute value. Period between endpoint scans. 0 for disabled.
 
const std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > & get_monitored_endpoints () const
 Get "monitored_endpoints" relationship value. List of monitored endpoint locations.
 
void set_monitored_endpoints (const std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > &value)
 Set "monitored_endpoints" relationship value. List of monitored endpoint locations.
 
- Public Member Functions inherited from dunedaq::timinglibs::dal::TimingControllerConf
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.
 
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 ConfigObjectconfig_object () const
 
DalRegistryregistry () const noexcept
 
Configurationconfiguration () 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_timestamp_source_str () noexcept
 
static const std::string & __get_endpoint_scan_period_str () noexcept
 
static const std::string & __get_monitored_endpoints_str () noexcept
 
static const std::string & __get_timestamp_source_str () noexcept
 
static const std::string & __get_endpoint_scan_period_str () noexcept
 
static const std::string & __get_monitored_endpoints_str () noexcept
 
- Static Public Member Functions inherited from dunedaq::timinglibs::dal::TimingControllerConf
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_timestamp_source = "timestamp_source"
 
static const std::string s_endpoint_scan_period = "endpoint_scan_period"
 
static const std::string s_monitored_endpoints = "monitored_endpoints"
 
- Static Public Attributes inherited from dunedaq::timinglibs::dal::TimingControllerConf
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

 TimingMasterControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~TimingMasterControllerConf () 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
 
 TimingMasterControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~TimingMasterControllerConf () 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::timinglibs::dal::TimingControllerConf
 TimingControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~TimingControllerConf () noexcept
 
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
 
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

uint32_t m_timestamp_source
 
uint32_t m_endpoint_scan_period
 
std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > m_monitored_endpoints
 

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
 
DalRegistryp_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

TimingMasterController configuration

Definition at line 39 of file TimingMasterControllerConf.hpp.

Constructor & Destructor Documentation

◆ TimingMasterControllerConf() [1/2]

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

Definition at line 32 of file TimingMasterControllerConf.cpp.

32 :
35
36 {
37 ;
38 }
The base class for any generated DAL object.
Definition DalObject.hpp:45
TimingControllerConf(conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept

◆ ~TimingMasterControllerConf() [1/2]

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

Definition at line 89 of file TimingMasterControllerConf.cpp.

90 {
91 }

◆ TimingMasterControllerConf() [2/2]

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

◆ ~TimingMasterControllerConf() [2/2]

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

Member Function Documentation

◆ __get_endpoint_scan_period_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingMasterControllerConf::__get_endpoint_scan_period_str ( )
inlinestaticnoexcept

◆ __get_endpoint_scan_period_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingMasterControllerConf::__get_endpoint_scan_period_str ( )
inlinestaticnoexcept

Definition at line 103 of file TimingMasterControllerConf.hpp.

103{ return s_endpoint_scan_period; }

◆ __get_monitored_endpoints_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingMasterControllerConf::__get_monitored_endpoints_str ( )
inlinestaticnoexcept

◆ __get_monitored_endpoints_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingMasterControllerConf::__get_monitored_endpoints_str ( )
inlinestaticnoexcept

Definition at line 176 of file TimingMasterControllerConf.hpp.

176{ return s_monitored_endpoints; }

◆ __get_timestamp_source_str() [1/2]

static const std::string & dunedaq::timinglibs::dal::TimingMasterControllerConf::__get_timestamp_source_str ( )
inlinestaticnoexcept

◆ __get_timestamp_source_str() [2/2]

static const std::string & dunedaq::timinglibs::dal::TimingMasterControllerConf::__get_timestamp_source_str ( )
inlinestaticnoexcept

Definition at line 102 of file TimingMasterControllerConf.hpp.

102{ return s_timestamp_source; }

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::timinglibs::dal::TimingMasterControllerConf::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

Reimplemented from dunedaq::timinglibs::dal::TimingControllerConf.

Definition at line 93 of file TimingMasterControllerConf.cpp.

94 {
95 std::vector<const dunedaq::conffwk::DalObject *> vec;
96
97 if (!get(name, vec, upcast_unregistered, true))
98 throw_get_ex(name, s_class_name, this);
99
100 return vec;
101 }
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
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...

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::timinglibs::dal::TimingMasterControllerConf::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

Reimplemented from dunedaq::timinglibs::dal::TimingControllerConf.

◆ get() [3/4]

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

Definition at line 103 of file TimingMasterControllerConf.cpp.

104 {
105 if (first_call)
106 {
107 std::lock_guard scoped_lock(m_mutex);
108
109 check();
110 check_init();
111
112 if (get_rel_objects(name, upcast_unregistered, vec))
113 return true;
114 }
115
116 if (TimingControllerConf::get(name, vec, upcast_unregistered, false)) return true;
117
118 if (first_call)
119 return get_algo_objects(name, vec);
120
121 return false;
122 }
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
std::mutex m_mutex
Used to protect changes of DAL object.
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
void check_init() const
Check and initialize object if necessary.
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...

◆ get() [4/4]

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

◆ get_endpoint_scan_period() [1/2]

uint32_t dunedaq::timinglibs::dal::TimingMasterControllerConf::get_endpoint_scan_period ( ) const
inline

Get "endpoint_scan_period" attribute value. Period between endpoint scans. 0 for disabled.

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

Definition at line 147 of file TimingMasterControllerConf.hpp.

148 {
149 std::lock_guard scoped_lock(m_mutex);
150 check();
151 check_init();
153 }

◆ get_endpoint_scan_period() [2/2]

uint32_t dunedaq::timinglibs::dal::TimingMasterControllerConf::get_endpoint_scan_period ( ) const
inline

Get "endpoint_scan_period" attribute value. Period between endpoint scans. 0 for disabled.

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

Definition at line 147 of file TimingMasterControllerConf.hpp.

148 {
149 std::lock_guard scoped_lock(m_mutex);
150 check();
151 check_init();
153 }

◆ get_monitored_endpoints() [1/2]

const std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > & dunedaq::timinglibs::dal::TimingMasterControllerConf::get_monitored_endpoints ( ) const
inline

Get "monitored_endpoints" relationship value. List of monitored endpoint locations.

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

Definition at line 187 of file TimingMasterControllerConf.hpp.

188 {
189 std::lock_guard scoped_lock(m_mutex);
190 check();
191 check_init();
193 }
std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > m_monitored_endpoints

◆ get_monitored_endpoints() [2/2]

const std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > & dunedaq::timinglibs::dal::TimingMasterControllerConf::get_monitored_endpoints ( ) const
inline

Get "monitored_endpoints" relationship value. List of monitored endpoint locations.

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

Definition at line 187 of file TimingMasterControllerConf.hpp.

188 {
189 std::lock_guard scoped_lock(m_mutex);
190 check();
191 check_init();
193 }

◆ get_timestamp_source() [1/2]

uint32_t dunedaq::timinglibs::dal::TimingMasterControllerConf::get_timestamp_source ( ) const
inline

Get "timestamp_source" attribute value. TS source, 0 for upstream, 1 for software, 2 for mixed.

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

Definition at line 114 of file TimingMasterControllerConf.hpp.

115 {
116 std::lock_guard scoped_lock(m_mutex);
117 check();
118 check_init();
119 return m_timestamp_source;
120 }

◆ get_timestamp_source() [2/2]

uint32_t dunedaq::timinglibs::dal::TimingMasterControllerConf::get_timestamp_source ( ) const
inline

Get "timestamp_source" attribute value. TS source, 0 for upstream, 1 for software, 2 for mixed.

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

Definition at line 114 of file TimingMasterControllerConf.hpp.

115 {
116 std::lock_guard scoped_lock(m_mutex);
117 check();
118 check_init();
119 return m_timestamp_source;
120 }

◆ init() [1/2]

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

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingControllerConf.

Definition at line 73 of file TimingMasterControllerConf.cpp.

74 {
75 TimingControllerConf::init(init_children);
76
77 TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
78
79 try {
83 }
84 catch (dunedaq::conffwk::Exception & ex) {
85 throw_init_ex(ex);
86 }
87 }
void get(const std::string &name, T &value)
Get value of object's attribute or relationship.
void throw_init_ex(dunedaq::conffwk::Exception &ex)
throw object initialisation exception (i.e.
Definition DalObject.cpp:74
DalRegistry & p_registry
Configuration object.
ConfigObject p_obj
Config object used by given template object.
const T * _ref(ConfigObject &obj, const std::string &name, bool read_children)
Get signle value of object's relation and instantiate result with it (multi-thread safe).
#define TLOG_DEBUG(lvl,...)
Definition Logging.hpp:112

◆ init() [2/2]

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

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingControllerConf.

◆ print() [1/2]

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

Print details of the TimingMasterControllerConf 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

Reimplemented from dunedaq::timinglibs::dal::TimingControllerConf.

Definition at line 41 of file TimingMasterControllerConf.cpp.

42 {
43 check_init();
44
45 try {
46 const std::string str(indent+2, ' ');
47
48 if (print_header)
49 p_hdr(s, indent, s_class_name, "dunedaq::timinglibs::dal");
50
51
52 // print direct super-classes
53
55
56
57 // print direct attributes
58
61
62
63 // print direct relationships
64
66 }
67 catch (dunedaq::conffwk::Exception & ex) {
69 }
70 }
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
static void p_error(std::ostream &s, dunedaq::conffwk::Exception &ex)
print error text
Definition DalObject.cpp:59
virtual void print(unsigned int offset, bool print_header, std::ostream &s) const
Print details of the TimingControllerConf object.
void p_mv_rel(std::ostream &s, const std::string &str, const std::string &name, const T &objs) noexcept
print weak multi-value relationship
void p_sv_attr(std::ostream &s, const std::string &str, const std::string &name, const T &val) noexcept
print single-value attribute

◆ print() [2/2]

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

Print details of the TimingMasterControllerConf 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

Reimplemented from dunedaq::timinglibs::dal::TimingControllerConf.

◆ set_endpoint_scan_period() [1/2]

void dunedaq::timinglibs::dal::TimingMasterControllerConf::set_endpoint_scan_period ( uint32_t value)
inline

Set "endpoint_scan_period" attribute value. Period between endpoint scans. 0 for disabled.

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

Definition at line 163 of file TimingMasterControllerConf.hpp.

164 {
165 std::lock_guard scoped_lock(m_mutex);
166 check();
167 clear();
169 }
void set_by_val(const std::string &name, T value)
Set attribute value.

◆ set_endpoint_scan_period() [2/2]

void dunedaq::timinglibs::dal::TimingMasterControllerConf::set_endpoint_scan_period ( uint32_t value)
inline

Set "endpoint_scan_period" attribute value. Period between endpoint scans. 0 for disabled.

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

Definition at line 163 of file TimingMasterControllerConf.hpp.

164 {
165 std::lock_guard scoped_lock(m_mutex);
166 check();
167 clear();
169 }

◆ set_monitored_endpoints() [1/2]

void dunedaq::timinglibs::dal::TimingMasterControllerConf::set_monitored_endpoints ( const std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > & value)

Set "monitored_endpoints" relationship value. List of monitored endpoint locations.

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

Definition at line 124 of file TimingMasterControllerConf.cpp.

125 {
127 }
void _set_objects(const std::string &name, const std::vector< const T * > &value)
Helper method for generated set multi-value relationship methods.

◆ set_monitored_endpoints() [2/2]

void dunedaq::timinglibs::dal::TimingMasterControllerConf::set_monitored_endpoints ( const std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > & value)

Set "monitored_endpoints" relationship value. List of monitored endpoint locations.

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

◆ set_timestamp_source() [1/2]

void dunedaq::timinglibs::dal::TimingMasterControllerConf::set_timestamp_source ( uint32_t value)
inline

Set "timestamp_source" attribute value. TS source, 0 for upstream, 1 for software, 2 for mixed.

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

Definition at line 130 of file TimingMasterControllerConf.hpp.

131 {
132 std::lock_guard scoped_lock(m_mutex);
133 check();
134 clear();
136 }

◆ set_timestamp_source() [2/2]

void dunedaq::timinglibs::dal::TimingMasterControllerConf::set_timestamp_source ( uint32_t value)
inline

Set "timestamp_source" attribute value. TS source, 0 for upstream, 1 for software, 2 for mixed.

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

Definition at line 130 of file TimingMasterControllerConf.hpp.

131 {
132 std::lock_guard scoped_lock(m_mutex);
133 check();
134 clear();
136 }

Friends And Related Symbol Documentation

◆ conffwk::Configuration

Definition at line 41 of file TimingMasterControllerConf.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 43 of file TimingMasterControllerConf.hpp.

◆ conffwk::DalObject

Definition at line 42 of file TimingMasterControllerConf.hpp.

◆ conffwk::DalRegistry

Definition at line 44 of file TimingMasterControllerConf.hpp.

Member Data Documentation

◆ m_endpoint_scan_period

uint32_t dunedaq::timinglibs::dal::TimingMasterControllerConf::m_endpoint_scan_period
private

Definition at line 91 of file TimingMasterControllerConf.hpp.

◆ m_monitored_endpoints

std::vector< const dunedaq::timinglibs::dal::EndpointLocation * > dunedaq::timinglibs::dal::TimingMasterControllerConf::m_monitored_endpoints
private

Definition at line 92 of file TimingMasterControllerConf.hpp.

◆ m_timestamp_source

uint32_t dunedaq::timinglibs::dal::TimingMasterControllerConf::m_timestamp_source
private

Definition at line 90 of file TimingMasterControllerConf.hpp.

◆ s_class_name

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

The name of the configuration class.

Definition at line 56 of file TimingMasterControllerConf.hpp.

◆ s_endpoint_scan_period

static const std::string dunedaq::timinglibs::dal::TimingMasterControllerConf::s_endpoint_scan_period = "endpoint_scan_period"
inlinestatic

Definition at line 100 of file TimingMasterControllerConf.hpp.

◆ s_monitored_endpoints

static const std::string dunedaq::timinglibs::dal::TimingMasterControllerConf::s_monitored_endpoints = "monitored_endpoints"
inlinestatic

Definition at line 174 of file TimingMasterControllerConf.hpp.

◆ s_timestamp_source

static const std::string dunedaq::timinglibs::dal::TimingMasterControllerConf::s_timestamp_source = "timestamp_source"
inlinestatic

Definition at line 99 of file TimingMasterControllerConf.hpp.


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