dunedaq::timing::TimingSourceMuxDesignInterface Class Reference

Base class for timing endpoint design nodes. More...

#include <TimingSourceMuxDesignInterface.hpp>

Inheritance diagram for dunedaq::timing::TimingSourceMuxDesignInterface:

Collaboration diagram for dunedaq::timing::TimingSourceMuxDesignInterface:

Public Member Functions
	TimingSourceMuxDesignInterface (const uhal::Node &node)
virtual	~TimingSourceMuxDesignInterface ()
virtual uint8_t	read_active_timing_source_mux () const
	Read timing source mux.
virtual void	switch_timing_source_mux (uint8_t mux_channel) const
	Switch timing source mux.
virtual void	switch_timing_source (ClockSource clock_source) const =0
	Switch timing source.
Public Member Functions inherited from dunedaq::timing::TopDesignInterface
	TopDesignInterface (const uhal::Node &node)
virtual	~TopDesignInterface ()
virtual const IONode *	get_io_node_plain () const =0
	Get io node pointer.
template<class IO >
const IO *	get_io_node () const
virtual void	soft_reset_io () const =0
	Reset timing node.
virtual void	reset_io (const std::string &clock_config_file) const =0
	Reset timing node.
virtual void	reset_io (const ClockSource &clock_source) const =0
	Reset timing node.
virtual void	configure (ClockSource clock_source) const =0
	Prepare the timing device for data taking.
virtual std::string	get_hardware_info (bool print_out=false) const =0
	Print hardware information.
virtual uint32_t	read_firmware_version () const =0
	Read firmware version.
virtual void	validate_firmware_version () const =0
	Validate firmware version.
virtual void	get_info (timingfirmwareinfo::TimingDeviceInfo &mon_data) const =0
	Give info to collector.
Public Member Functions inherited from dunedaq::timing::TimingNode
	TimingNode (const uhal::Node &node)
virtual	~TimingNode ()
virtual std::string	get_status (bool print_out=false) const =0
	Get the status string of the timing node. Optionally print it.
std::map< std::string, uhal::ValWord< uint32_t > >	read_sub_nodes (const uhal::Node &node, bool dispatch=true) const
	Read subnodes.
void	reset_sub_nodes (const uhal::Node &node, uint32_t aValue=0x0, bool dispatch=true) const
	Reset subnodes.

Detailed Description

Base class for timing endpoint design nodes.

Definition at line 33 of file TimingSourceMuxDesignInterface.hpp.

Constructor & Destructor Documentation

TimingSourceMuxDesignInterface()

dunedaq::timing::TimingSourceMuxDesignInterface::TimingSourceMuxDesignInterface ( const uhal::Node & node )

inlineexplicit

Definition at line 37 of file TimingSourceMuxDesignInterface.hpp.

    : TopDesignInterface(node) {}

~TimingSourceMuxDesignInterface()

virtual dunedaq::timing::TimingSourceMuxDesignInterface::~TimingSourceMuxDesignInterface ( )

inlinevirtual

Definition at line 39 of file TimingSourceMuxDesignInterface.hpp.

{}

Member Function Documentation

read_active_timing_source_mux()

virtual uint8_t dunedaq::timing::TimingSourceMuxDesignInterface::read_active_timing_source_mux ( ) const

inlinevirtual

Read timing source mux.

Returns

{ description_of_the_return_value }

Definition at line 46 of file TimingSourceMuxDesignInterface.hpp.

  {
    auto active_sfp_mux_channel = getNode("timing_source_mux.csr.ctrl.src").read();
    getClient().dispatch();
    return active_sfp_mux_channel.value();
  }

switch_timing_source()

virtual void dunedaq::timing::TimingSourceMuxDesignInterface::switch_timing_source ( ClockSource clock_source ) const

pure virtual

Switch timing source.

Implemented in dunedaq::timing::KerberosDesign.

switch_timing_source_mux()

virtual void dunedaq::timing::TimingSourceMuxDesignInterface::switch_timing_source_mux ( uint8_t mux_channel ) const

inlinevirtual

Switch timing source mux.

Returns

{ description_of_the_return_value }

Definition at line 58 of file TimingSourceMuxDesignInterface.hpp.

  {
    // TODO add mux channel validity check
    getNode("timing_source_mux.csr.ctrl.src").write(mux_channel);
    getClient().dispatch();
  }

---

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

• /github/workspace/dunedaq/sourcecode/timing/include/timing/TimingSourceMuxDesignInterface.hpp