dunedaq::timing::TopDesign Class Reference

Base class for timing top design nodes with IO class. More...

#include <TopDesign.hpp>

Inheritance diagram for dunedaq::timing::TopDesign:

Collaboration diagram for dunedaq::timing::TopDesign:

Public Member Functions
	TopDesign (const uhal::Node &node)
virtual	~TopDesign ()
const IONode *	get_io_node_plain () const override
	Get io node pointer.
void	soft_reset_io () const override
	Reset timing node.
void	reset_io (const std::string &clock_config_file) const override
	Reset timing node.
void	reset_io (const ClockSource &clock_source) const override
	Reset timing node.
void	configure (ClockSource clock_source) const override
	Prepare the timing device for data taking.
std::string	get_hardware_info (bool print_out=false) const override
	Print hardware information.
void	get_info (timingfirmwareinfo::TimingDeviceInfo &mon_data) const override
	Give info to collector.
Public Member Functions inherited from dunedaq::timing::TopDesignInterface
	TopDesignInterface (const uhal::Node &node)
virtual	~TopDesignInterface ()
template<class IO >
const IO *	get_io_node () const
virtual uint32_t	read_firmware_version () const =0
	Read firmware version.
virtual void	validate_firmware_version () const =0
	Validate firmware version.
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 top design nodes with IO class.

Definition at line 38 of file TopDesign.hpp.

Constructor & Destructor Documentation

TopDesign()

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

inlineexplicit

Definition at line 41 of file TopDesign.hpp.

    : TopDesignInterface(node) {}

~TopDesign()

virtual dunedaq::timing::TopDesign::~TopDesign ( )

inlinevirtual

Definition at line 43 of file TopDesign.hpp.

{}

Member Function Documentation

configure()

void dunedaq::timing::TopDesign::configure ( ClockSource clock_source ) const

inlineoverridevirtual

Prepare the timing device for data taking.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 81 of file TopDesign.hpp.

  {
    // Hard resets
    this->reset_io(clock_source);
 
    auto start = std::chrono::high_resolution_clock::now();
 
    // Wait for clocks to be happy
    while (true)
    {
      if (get_io_node_plain()->clocks_ok())
      {
        TLOG() << "Clocks ready!";
        break;
      }
 
      auto now = std::chrono::high_resolution_clock::now();
      auto ms_since_start = std::chrono::duration_cast<std::chrono::milliseconds>(now - start);
 
      if (ms_since_start.count() > 500)
        throw ClocksNotReady(ERS_HERE, "IO");
 
      std::this_thread::sleep_for(std::chrono::microseconds(10));
    }
  }

get_hardware_info()

std::string dunedaq::timing::TopDesign::get_hardware_info ( bool print_out = false ) const

inlineoverridevirtual

Print hardware information.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 110 of file TopDesign.hpp.

  {
    auto info = get_io_node_plain()->get_hardware_info();
    if (print_out)
      TLOG() << info;
    return info;
  }

get_info()

void dunedaq::timing::TopDesign::get_info ( timingfirmwareinfo::TimingDeviceInfo & mon_data ) const

inlineoverridevirtual

Give info to collector.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 121 of file TopDesign.hpp.

  {
    get_io_node_plain()->get_info(mon_data.pll_info);
  }

get_io_node_plain()

const IONode * dunedaq::timing::TopDesign::get_io_node_plain ( ) const

inlineoverridevirtual

Get io node pointer.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 48 of file TopDesign.hpp.

  { 
    return dynamic_cast<const IONode*>(&uhal::Node::getNode("io")); 
  }

reset_io() [1/2]

void dunedaq::timing::TopDesign::reset_io ( const ClockSource & clock_source ) const

inlineoverridevirtual

Reset timing node.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 72 of file TopDesign.hpp.

  {
    get_io_node_plain()->reset(clock_source);
  }

reset_io() [2/2]

void dunedaq::timing::TopDesign::reset_io ( const std::string & clock_config_file ) const

inlineoverridevirtual

Reset timing node.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 64 of file TopDesign.hpp.

  {
    get_io_node_plain()->reset(clock_config_file);
  }

soft_reset_io()

void dunedaq::timing::TopDesign::soft_reset_io ( ) const

inlineoverridevirtual

Reset timing node.

Implements dunedaq::timing::TopDesignInterface.

Definition at line 56 of file TopDesign.hpp.

  {
    get_io_node_plain()->soft_reset();
  }

---

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

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