dunedaq::timing::EndpointDesignInterface Class Reference

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

#include <EndpointDesignInterface.hpp>

Inheritance diagram for dunedaq::timing::EndpointDesignInterface:

Collaboration diagram for dunedaq::timing::EndpointDesignInterface:

Public Member Functions
	EndpointDesignInterface (const uhal::Node &node)
virtual	~EndpointDesignInterface ()
virtual const EndpointNodeInterface *	get_endpoint_node_plain (uint32_t ept_id) const
	Return the timing endpoint node.
virtual uint32_t	get_number_of_endpoint_nodes () const
	Return the timing endpoint node.
virtual void	get_info (uint32_t ept_id, timingendpointinfo::TimingEndpointInfo &mon_data) const
	Give info to collector.
virtual void	get_info (timingfirmwareinfo::TimingDeviceInfo &mon_data) const=0
	Give info to collector.
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.
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 37 of file EndpointDesignInterface.hpp.

Constructor & Destructor Documentation

EndpointDesignInterface()

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

inlineexplicit

Definition at line 41 of file EndpointDesignInterface.hpp.

    : TopDesignInterface(node) {}

~EndpointDesignInterface()

virtual dunedaq::timing::EndpointDesignInterface::~EndpointDesignInterface ( )

inlinevirtual

Definition at line 43 of file EndpointDesignInterface.hpp.

{}

Member Function Documentation

get_endpoint_node_plain()

virtual const EndpointNodeInterface * dunedaq::timing::EndpointDesignInterface::get_endpoint_node_plain ( uint32_t ept_id ) const

inlinevirtual

Return the timing endpoint node.

Returns

{ description_of_the_return_value }

Definition at line 50 of file EndpointDesignInterface.hpp.

  {
    const std::string node_name = "endpoint" + std::to_string(ept_id);
    return dynamic_cast<const EndpointNodeInterface*>(&uhal::Node::getNode(node_name)); 
  }

get_info() [1/2]

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

virtual

Give info to collector.

Implements dunedaq::timing::TopDesignInterface.

Reimplemented in dunedaq::timing::FanoutDesign, dunedaq::timing::GaiaDesign, and dunedaq::timing::HSIDesignInterface.

get_info() [2/2]

virtual void dunedaq::timing::EndpointDesignInterface::get_info ( uint32_t ept_id, timingendpointinfo::TimingEndpointInfo & mon_data ) const

inlinevirtual

Give info to collector.

Reimplemented in dunedaq::timing::HSIDesignInterface.

Definition at line 70 of file EndpointDesignInterface.hpp.

  {
    get_endpoint_node_plain(ept_id)->get_info(mon_data);
  }

get_number_of_endpoint_nodes()

virtual uint32_t dunedaq::timing::EndpointDesignInterface::get_number_of_endpoint_nodes ( ) const

inlinevirtual

Return the timing endpoint node.

Returns

{ description_of_the_return_value }

Definition at line 61 of file EndpointDesignInterface.hpp.

  {
    std::string regex_string = "endpoint[0-9]+";
    return uhal::Node::getNodes(regex_string).size();
  }

---

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

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