dunedaq::hsilibs::dal::HSIControllerConf Class Reference

#include <HSIControllerConf.hpp>

Inheritance diagram for dunedaq::hsilibs::dal::HSIControllerConf:

Collaboration diagram for dunedaq::hsilibs::dal::HSIControllerConf:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the HSIControllerConf 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.
double	get_trigger_rate () const
	Get "trigger_rate" attribute value.
void	set_trigger_rate (double value)
	Set "trigger_rate" attribute value.
bool	get_control_hardware_io () const
	Get "control_hardware_io" attribute value. control flag for controlling hardware io.
void	set_control_hardware_io (bool value)
	Set "control_hardware_io" attribute value. control flag for controlling hardware io.
uint32_t	get_rising_edge_mask () const
	Get "rising_edge_mask" attribute value. Rising edge mask for HSI triggering.
void	set_rising_edge_mask (uint32_t value)
	Set "rising_edge_mask" attribute value. Rising edge mask for HSI triggering.
uint32_t	get_falling_edge_mask () const
	Get "falling_edge_mask" attribute value. Falling edge mask for HSI triggering.
void	set_falling_edge_mask (uint32_t value)
	Set "falling_edge_mask" attribute value. Falling edge mask for HSI triggering.
uint32_t	get_invert_edge_mask () const
	Get "invert_edge_mask" attribute value. Invert edge mask for HSI triggering.
void	set_invert_edge_mask (uint32_t value)
	Set "invert_edge_mask" attribute value. Invert edge mask for HSI triggering.
uint32_t	get_data_source () const
	Get "data_source" attribute value. Source of data for HSI triggering.
void	set_data_source (uint32_t value)
	Set "data_source" attribute value. Source of data for HSI triggering.
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the HSIControllerConf 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.
double	get_trigger_rate () const
	Get "trigger_rate" attribute value.
void	set_trigger_rate (double value)
	Set "trigger_rate" attribute value.
bool	get_control_hardware_io () const
	Get "control_hardware_io" attribute value. control flag for controlling hardware io.
void	set_control_hardware_io (bool value)
	Set "control_hardware_io" attribute value. control flag for controlling hardware io.
uint32_t	get_rising_edge_mask () const
	Get "rising_edge_mask" attribute value. Rising edge mask for HSI triggering.
void	set_rising_edge_mask (uint32_t value)
	Set "rising_edge_mask" attribute value. Rising edge mask for HSI triggering.
uint32_t	get_falling_edge_mask () const
	Get "falling_edge_mask" attribute value. Falling edge mask for HSI triggering.
void	set_falling_edge_mask (uint32_t value)
	Set "falling_edge_mask" attribute value. Falling edge mask for HSI triggering.
uint32_t	get_invert_edge_mask () const
	Get "invert_edge_mask" attribute value. Invert edge mask for HSI triggering.
void	set_invert_edge_mask (uint32_t value)
	Set "invert_edge_mask" attribute value. Invert edge mask for HSI triggering.
uint32_t	get_data_source () const
	Get "data_source" attribute value. Source of data for HSI triggering.
void	set_data_source (uint32_t value)
	Set "data_source" attribute value. Source of data for HSI triggering.
Public Member Functions inherited from dunedaq::timinglibs::dal::TimingEndpointControllerConf
uint32_t	get_endpoint_id () const
	Get "endpoint_id" attribute value. ID of target endpoint.
void	set_endpoint_id (uint32_t value)
	Set "endpoint_id" attribute value. ID of target endpoint.
uint32_t	get_address () const
	Get "address" attribute value. Endpoint address.
void	set_address (uint32_t value)
	Set "address" attribute value. Endpoint address.
uint32_t	get_partition () const
	Get "partition" attribute value. Endpoint partition.
void	set_partition (uint32_t value)
	Set "partition" attribute value. Endpoint partition.
uint32_t	get_endpoint_id () const
	Get "endpoint_id" attribute value. ID of target endpoint.
void	set_endpoint_id (uint32_t value)
	Set "endpoint_id" attribute value. ID of target endpoint.
uint32_t	get_address () const
	Get "address" attribute value. Endpoint address.
void	set_address (uint32_t value)
	Set "address" attribute value. Endpoint address.
uint32_t	get_partition () const
	Get "partition" attribute value. Endpoint partition.
void	set_partition (uint32_t value)
	Set "partition" attribute value. Endpoint partition.
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 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.
Public Member Functions inherited from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf
const std::string &	get_uhal_log_level () const
	Get "uhal_log_level" attribute value. Log level for uhal.
void	set_uhal_log_level (const std::string &value)
	Set "uhal_log_level" attribute value. Log level for uhal.
const std::string &	get_connections_file () const
	Get "connections_file" attribute value. device connections file.
void	set_connections_file (const std::string &value)
	Set "connections_file" attribute value. device connections file.
const std::string &	get_uhal_log_level () const
	Get "uhal_log_level" attribute value. Log level for uhal.
void	set_uhal_log_level (const std::string &value)
	Set "uhal_log_level" attribute value. Log level for uhal.
const std::string &	get_connections_file () const
	Get "connections_file" attribute value. device connections file.
void	set_connections_file (const std::string &value)
	Set "connections_file" attribute value. device connections file.

Static Public Member Functions
static const std::string &	__get_trigger_rate_str () noexcept
static const std::string &	__get_control_hardware_io_str () noexcept
static const std::string &	__get_rising_edge_mask_str () noexcept
static const std::string &	__get_falling_edge_mask_str () noexcept
static const std::string &	__get_invert_edge_mask_str () noexcept
static const std::string &	__get_data_source_str () noexcept
static const std::string &	__get_trigger_rate_str () noexcept
static const std::string &	__get_control_hardware_io_str () noexcept
static const std::string &	__get_rising_edge_mask_str () noexcept
static const std::string &	__get_falling_edge_mask_str () noexcept
static const std::string &	__get_invert_edge_mask_str () noexcept
static const std::string &	__get_data_source_str () noexcept
Static Public Member Functions inherited from dunedaq::timinglibs::dal::TimingEndpointControllerConf
static const std::string &	__get_endpoint_id_str () noexcept
static const std::string &	__get_address_str () noexcept
static const std::string &	__get_partition_str () noexcept
static const std::string &	__get_endpoint_id_str () noexcept
static const std::string &	__get_address_str () noexcept
static const std::string &	__get_partition_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 Member Functions inherited from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf
static const std::string &	__get_uhal_log_level_str () noexcept
static const std::string &	__get_connections_file_str () noexcept
static const std::string &	__get_uhal_log_level_str () noexcept
static const std::string &	__get_connections_file_str () noexcept

Static Public Attributes
static const std::string &	s_class_name
static const std::string	s_trigger_rate = "trigger_rate"
static const std::string	s_control_hardware_io = "control_hardware_io"
static const std::string	s_rising_edge_mask = "rising_edge_mask"
static const std::string	s_falling_edge_mask = "falling_edge_mask"
static const std::string	s_invert_edge_mask = "invert_edge_mask"
static const std::string	s_data_source = "data_source"
Static Public Attributes inherited from dunedaq::timinglibs::dal::TimingEndpointControllerConf
static const std::string &	s_class_name
static const std::string	s_endpoint_id = "endpoint_id"
static const std::string	s_address = "address"
static const std::string	s_partition = "partition"
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"
Static Public Attributes inherited from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf
static const std::string &	s_class_name
static const std::string	s_uhal_log_level = "uhal_log_level"
static const std::string	s_connections_file = "connections_file"

Protected Member Functions
	HSIControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~HSIControllerConf () 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
	HSIControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~HSIControllerConf () 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::TimingEndpointControllerConf
	TimingEndpointControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingEndpointControllerConf () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	TimingEndpointControllerConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingEndpointControllerConf () 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::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.
Protected Member Functions inherited from dunedaq::timinglibs::dal::TimingHardwareInterfaceConf
	TimingHardwareInterfaceConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingHardwareInterfaceConf () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	TimingHardwareInterfaceConf (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~TimingHardwareInterfaceConf () noexcept
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const

Private Attributes
double	m_trigger_rate
bool	m_control_hardware_io
uint32_t	m_rising_edge_mask
uint32_t	m_falling_edge_mask
uint32_t	m_invert_edge_mask
uint32_t	m_data_source

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 25 of file HSIControllerConf.hpp.

Constructor & Destructor Documentation

HSIControllerConf() [1/2]

dunedaq::hsilibs::dal::HSIControllerConf::HSIControllerConf ( conffwk::DalRegistry & db, const conffwk::ConfigObject & obj )

protectednoexcept

Definition at line 27 of file HSIControllerConf.cpp.

                                                                                                        :
        dunedaq::conffwk::DalObject(db, o),
        dunedaq::timinglibs::dal::TimingEndpointControllerConf(db, o),
        dunedaq::timinglibs::dal::TimingHardwareInterfaceConf(db, o)
 
      {
        ;
      }

~HSIControllerConf() [1/2]

dunedaq::hsilibs::dal::HSIControllerConf::~HSIControllerConf ( )

protectedvirtualnoexcept

Definition at line 89 of file HSIControllerConf.cpp.

      {
      }

HSIControllerConf() [2/2]

dunedaq::hsilibs::dal::HSIControllerConf::HSIControllerConf ( conffwk::DalRegistry & db, const conffwk::ConfigObject & obj )

protectednoexcept

~HSIControllerConf() [2/2]

virtual dunedaq::hsilibs::dal::HSIControllerConf::~HSIControllerConf ( )

protectedvirtualnoexcept

Member Function Documentation

__get_control_hardware_io_str() [1/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_control_hardware_io_str ( )

inlinestaticnoexcept

Definition at line 96 of file HSIControllerConf.hpp.

{ return s_control_hardware_io; }

__get_control_hardware_io_str() [2/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_control_hardware_io_str ( )

inlinestaticnoexcept

Definition at line 96 of file HSIControllerConf.hpp.

{ return s_control_hardware_io; }

__get_data_source_str() [1/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_data_source_str ( )

inlinestaticnoexcept

Definition at line 100 of file HSIControllerConf.hpp.

{ return s_data_source; }

__get_data_source_str() [2/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_data_source_str ( )

inlinestaticnoexcept

Definition at line 100 of file HSIControllerConf.hpp.

{ return s_data_source; }

__get_falling_edge_mask_str() [1/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_falling_edge_mask_str ( )

inlinestaticnoexcept

Definition at line 98 of file HSIControllerConf.hpp.

{ return s_falling_edge_mask; }

__get_falling_edge_mask_str() [2/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_falling_edge_mask_str ( )

inlinestaticnoexcept

Definition at line 98 of file HSIControllerConf.hpp.

{ return s_falling_edge_mask; }

__get_invert_edge_mask_str() [1/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_invert_edge_mask_str ( )

inlinestaticnoexcept

Definition at line 99 of file HSIControllerConf.hpp.

{ return s_invert_edge_mask; }

__get_invert_edge_mask_str() [2/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_invert_edge_mask_str ( )

inlinestaticnoexcept

Definition at line 99 of file HSIControllerConf.hpp.

{ return s_invert_edge_mask; }

__get_rising_edge_mask_str() [1/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_rising_edge_mask_str ( )

inlinestaticnoexcept

Definition at line 97 of file HSIControllerConf.hpp.

{ return s_rising_edge_mask; }

__get_rising_edge_mask_str() [2/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_rising_edge_mask_str ( )

inlinestaticnoexcept

Definition at line 97 of file HSIControllerConf.hpp.

{ return s_rising_edge_mask; }

__get_trigger_rate_str() [1/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_trigger_rate_str ( )

inlinestaticnoexcept

Definition at line 95 of file HSIControllerConf.hpp.

{ return s_trigger_rate; }

__get_trigger_rate_str() [2/2]

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::__get_trigger_rate_str ( )

inlinestaticnoexcept

Definition at line 95 of file HSIControllerConf.hpp.

{ return s_trigger_rate; }

get() [1/4]

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

name	name of the relationship or algorithm

Returns

value of relationship or result of algorithm

Exceptions

std::exception

if there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::timinglibs::dal::TimingEndpointControllerConf.

Definition at line 93 of file HSIControllerConf.cpp.

      {
        std::vector<const dunedaq::conffwk::DalObject *> vec;
 
        if (!get(name, vec, upcast_unregistered, true))
          throw_get_ex(name, s_class_name, this);
 
        return vec;
      }

get() [2/4]

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

name	name of the relationship or algorithm

Returns

value of relationship or result of algorithm

Exceptions

std::exception

if there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::timinglibs::dal::TimingEndpointControllerConf.

get() [3/4]

bool dunedaq::hsilibs::dal::HSIControllerConf::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 HSIControllerConf.cpp.

      {
        if (first_call)
          {
            std::lock_guard scoped_lock(m_mutex);
 
            check();
            check_init();
 
            if (get_rel_objects(name, upcast_unregistered, vec))
              return true;
          }
 
        if (TimingEndpointControllerConf::get(name, vec, upcast_unregistered, false)) return true;
        if (TimingHardwareInterfaceConf::get(name, vec, upcast_unregistered, false)) return true;
 
        if (first_call)
          return get_algo_objects(name, vec);
 
        return false;
      }

get() [4/4]

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

protected

get_control_hardware_io() [1/2]

bool dunedaq::hsilibs::dal::HSIControllerConf::get_control_hardware_io ( ) const

inline

Get "control_hardware_io" attribute value. control flag for controlling hardware io.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 142 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_control_hardware_io;
            }

get_control_hardware_io() [2/2]

bool dunedaq::hsilibs::dal::HSIControllerConf::get_control_hardware_io ( ) const

inline

Get "control_hardware_io" attribute value. control flag for controlling hardware io.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 142 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_control_hardware_io;
            }

get_data_source() [1/2]

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::get_data_source ( ) const

inline

Get "data_source" attribute value. Source of data for HSI triggering.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 274 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_data_source;
            }

get_data_source() [2/2]

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::get_data_source ( ) const

inline

Get "data_source" attribute value. Source of data for HSI triggering.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 274 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_data_source;
            }

get_falling_edge_mask() [1/2]

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::get_falling_edge_mask ( ) const

inline

Get "falling_edge_mask" attribute value. Falling edge mask for HSI triggering.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 208 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_falling_edge_mask;
            }

get_falling_edge_mask() [2/2]

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::get_falling_edge_mask ( ) const

inline

Get "falling_edge_mask" attribute value. Falling edge mask for HSI triggering.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 208 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_falling_edge_mask;
            }

get_invert_edge_mask() [1/2]

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::get_invert_edge_mask ( ) const

inline

Get "invert_edge_mask" attribute value. Invert edge mask for HSI triggering.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 241 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_invert_edge_mask;
            }

get_invert_edge_mask() [2/2]

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::get_invert_edge_mask ( ) const

inline

Get "invert_edge_mask" attribute value. Invert edge mask for HSI triggering.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 241 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_invert_edge_mask;
            }

get_rising_edge_mask() [1/2]

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::get_rising_edge_mask ( ) const

inline

Get "rising_edge_mask" attribute value. Rising edge mask for HSI triggering.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 175 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_rising_edge_mask;
            }

get_rising_edge_mask() [2/2]

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::get_rising_edge_mask ( ) const

inline

Get "rising_edge_mask" attribute value. Rising edge mask for HSI triggering.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 175 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_rising_edge_mask;
            }

get_trigger_rate() [1/2]

double dunedaq::hsilibs::dal::HSIControllerConf::get_trigger_rate ( ) const

inline

Get "trigger_rate" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 110 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_trigger_rate;
            }

get_trigger_rate() [2/2]

double dunedaq::hsilibs::dal::HSIControllerConf::get_trigger_rate ( ) const

inline

Get "trigger_rate" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 110 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              check_init();
              return m_trigger_rate;
            }

init() [1/2]

void dunedaq::hsilibs::dal::HSIControllerConf::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingEndpointControllerConf.

Definition at line 69 of file HSIControllerConf.cpp.

      {
        TimingEndpointControllerConf::init(init_children);
        TimingHardwareInterfaceConf::init(init_children);
 
        TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
        try {
          p_obj.get(s_trigger_rate, m_trigger_rate);
          p_obj.get(s_control_hardware_io, m_control_hardware_io);
          p_obj.get(s_rising_edge_mask, m_rising_edge_mask);
          p_obj.get(s_falling_edge_mask, m_falling_edge_mask);
          p_obj.get(s_invert_edge_mask, m_invert_edge_mask);
          p_obj.get(s_data_source, m_data_source);
        }
        catch (dunedaq::conffwk::Exception & ex) {
          throw_init_ex(ex);
        }
      }

init() [2/2]

virtual void dunedaq::hsilibs::dal::HSIControllerConf::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Reimplemented from dunedaq::timinglibs::dal::TimingEndpointControllerConf.

print() [1/2]

void dunedaq::hsilibs::dal::HSIControllerConf::print ( unsigned int offset, bool print_header, std::ostream & s ) const

virtual

Print details of the HSIControllerConf object.

Parameters are:

Parameters

offset	number of spaces to shift object right (useful to print nested objects)
print_header	if false, do not print object header (to print attributes of base classes)
s	output stream

Reimplemented from dunedaq::timinglibs::dal::TimingEndpointControllerConf.

Definition at line 37 of file HSIControllerConf.cpp.

      {
        check_init();
 
        try {
          const std::string str(indent+2, ' ');
 
          if (print_header)
            p_hdr(s, indent, s_class_name, "dunedaq::hsilibs::dal");
 
 
            // print direct super-classes
 
          dunedaq::timinglibs::dal::TimingEndpointControllerConf::print(indent, false, s);
          dunedaq::timinglibs::dal::TimingHardwareInterfaceConf::print(indent, false, s);
 
 
            // print direct attributes
 
          dunedaq::conffwk::p_sv_attr(s, str, s_trigger_rate, m_trigger_rate);
          dunedaq::conffwk::p_sv_attr(s, str, s_control_hardware_io, m_control_hardware_io);
          dunedaq::conffwk::p_sv_attr(s, str, s_rising_edge_mask, m_rising_edge_mask);
          dunedaq::conffwk::p_sv_attr(s, str, s_falling_edge_mask, m_falling_edge_mask);
          dunedaq::conffwk::p_sv_attr(s, str, s_invert_edge_mask, m_invert_edge_mask);
          dunedaq::conffwk::p_sv_attr(s, str, s_data_source, m_data_source);
        }
        catch (dunedaq::conffwk::Exception & ex) {
          dunedaq::conffwk::DalObject::p_error(s, ex);
        }
      }

print() [2/2]

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

virtual

Print details of the HSIControllerConf object.

Parameters are:

Parameters

offset	number of spaces to shift object right (useful to print nested objects)
print_header	if false, do not print object header (to print attributes of base classes)
s	output stream

Reimplemented from dunedaq::timinglibs::dal::TimingEndpointControllerConf.

set_control_hardware_io() [1/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_control_hardware_io ( bool value )

inline

Set "control_hardware_io" attribute value. control flag for controlling hardware io.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 158 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_control_hardware_io, value);
            }

set_control_hardware_io() [2/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_control_hardware_io ( bool value )

inline

Set "control_hardware_io" attribute value. control flag for controlling hardware io.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 158 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_control_hardware_io, value);
            }

set_data_source() [1/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_data_source ( uint32_t value )

inline

Set "data_source" attribute value. Source of data for HSI triggering.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 290 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_data_source, value);
            }

set_data_source() [2/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_data_source ( uint32_t value )

inline

Set "data_source" attribute value. Source of data for HSI triggering.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 290 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_data_source, value);
            }

set_falling_edge_mask() [1/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_falling_edge_mask ( uint32_t value )

inline

Set "falling_edge_mask" attribute value. Falling edge mask for HSI triggering.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 224 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_falling_edge_mask, value);
            }

set_falling_edge_mask() [2/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_falling_edge_mask ( uint32_t value )

inline

Set "falling_edge_mask" attribute value. Falling edge mask for HSI triggering.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 224 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_falling_edge_mask, value);
            }

set_invert_edge_mask() [1/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_invert_edge_mask ( uint32_t value )

inline

Set "invert_edge_mask" attribute value. Invert edge mask for HSI triggering.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 257 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_invert_edge_mask, value);
            }

set_invert_edge_mask() [2/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_invert_edge_mask ( uint32_t value )

inline

Set "invert_edge_mask" attribute value. Invert edge mask for HSI triggering.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 257 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_invert_edge_mask, value);
            }

set_rising_edge_mask() [1/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_rising_edge_mask ( uint32_t value )

inline

Set "rising_edge_mask" attribute value. Rising edge mask for HSI triggering.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 191 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_rising_edge_mask, value);
            }

set_rising_edge_mask() [2/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_rising_edge_mask ( uint32_t value )

inline

Set "rising_edge_mask" attribute value. Rising edge mask for HSI triggering.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 191 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_rising_edge_mask, value);
            }

set_trigger_rate() [1/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_trigger_rate ( double value )

inline

Set "trigger_rate" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 125 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_trigger_rate, value);
            }

set_trigger_rate() [2/2]

void dunedaq::hsilibs::dal::HSIControllerConf::set_trigger_rate ( double value )

inline

Set "trigger_rate" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 125 of file HSIControllerConf.hpp.

            {
              std::lock_guard scoped_lock(m_mutex);
              check();
              clear();
              p_obj.set_by_val(s_trigger_rate, value);
            }

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 27 of file HSIControllerConf.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 29 of file HSIControllerConf.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 28 of file HSIControllerConf.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 30 of file HSIControllerConf.hpp.

Member Data Documentation

m_control_hardware_io

bool dunedaq::hsilibs::dal::HSIControllerConf::m_control_hardware_io

private

Definition at line 77 of file HSIControllerConf.hpp.

m_data_source

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::m_data_source

private

Definition at line 81 of file HSIControllerConf.hpp.

m_falling_edge_mask

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::m_falling_edge_mask

private

Definition at line 79 of file HSIControllerConf.hpp.

m_invert_edge_mask

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::m_invert_edge_mask

private

Definition at line 80 of file HSIControllerConf.hpp.

m_rising_edge_mask

uint32_t dunedaq::hsilibs::dal::HSIControllerConf::m_rising_edge_mask

private

Definition at line 78 of file HSIControllerConf.hpp.

m_trigger_rate

double dunedaq::hsilibs::dal::HSIControllerConf::m_trigger_rate

private

Definition at line 76 of file HSIControllerConf.hpp.

s_class_name

static const std::string & dunedaq::hsilibs::dal::HSIControllerConf::s_class_name

static

The name of the configuration class.

Definition at line 42 of file HSIControllerConf.hpp.

s_control_hardware_io

static const std::string dunedaq::hsilibs::dal::HSIControllerConf::s_control_hardware_io = "control_hardware_io"

inlinestatic

Definition at line 89 of file HSIControllerConf.hpp.

s_data_source

static const std::string dunedaq::hsilibs::dal::HSIControllerConf::s_data_source = "data_source"

inlinestatic

Definition at line 93 of file HSIControllerConf.hpp.

s_falling_edge_mask

static const std::string dunedaq::hsilibs::dal::HSIControllerConf::s_falling_edge_mask = "falling_edge_mask"

inlinestatic

Definition at line 91 of file HSIControllerConf.hpp.

s_invert_edge_mask

static const std::string dunedaq::hsilibs::dal::HSIControllerConf::s_invert_edge_mask = "invert_edge_mask"

inlinestatic

Definition at line 92 of file HSIControllerConf.hpp.

s_rising_edge_mask

static const std::string dunedaq::hsilibs::dal::HSIControllerConf::s_rising_edge_mask = "rising_edge_mask"

inlinestatic

Definition at line 90 of file HSIControllerConf.hpp.

s_trigger_rate

static const std::string dunedaq::hsilibs::dal::HSIControllerConf::s_trigger_rate = "trigger_rate"

inlinestatic

Definition at line 88 of file HSIControllerConf.hpp.

---

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

• /github/workspace/dunedaq/build/hsilibs/codegen/include/hsilibs/dal/HSIControllerConf.hpp
• /github/workspace/dunedaq/build/hsilibs/codegen/src/HSIControllerConf.hpp
• /github/workspace/dunedaq/build/hsilibs/codegen/src/HSIControllerConf.cpp