dunedaq::timing::EndpointNodeInterface Class Reference

Base class for timing IO nodes. More...

#include <EndpointNodeInterface.hpp>

Inheritance diagram for dunedaq::timing::EndpointNodeInterface:

Collaboration diagram for dunedaq::timing::EndpointNodeInterface:

Public Member Functions
	EndpointNodeInterface (const uhal::Node &node)
virtual	~EndpointNodeInterface ()
virtual void	enable (uint32_t address=0, uint32_t partition=0) const =0
	Enable the endpoint.
virtual void	disable () const =0
	Disable the endpoint.
virtual void	reset (uint32_t address=0, uint32_t partition=0) const =0
	Reset the endpoint.
virtual bool	endpoint_ready () const
	Get endpoint ready flag.
virtual uint32_t	read_endpoint_state () const
	Get endpoint state.
virtual void	get_info (timingendpointinfo::TimingEndpointInfo &) const
	Collect monitoring information for timing endpoint.
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 IO nodes.

Definition at line 35 of file EndpointNodeInterface.hpp.

Constructor & Destructor Documentation

EndpointNodeInterface()

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

explicit

Definition at line 18 of file EndpointNodeInterface.cpp.

  : TimingNode(node)
{}

~EndpointNodeInterface()

dunedaq::timing::EndpointNodeInterface::~EndpointNodeInterface ( )

virtual

Definition at line 24 of file EndpointNodeInterface.cpp.

{}

Member Function Documentation

disable()

virtual void dunedaq::timing::EndpointNodeInterface::disable ( ) const

pure virtual

Disable the endpoint.

Returns

{ description_of_the_return_value }

Implemented in dunedaq::timing::EndpointNode.

enable()

virtual void dunedaq::timing::EndpointNodeInterface::enable ( uint32_t address = 0, uint32_t partition = 0 ) const

pure virtual

Enable the endpoint.

Returns

{ description_of_the_return_value }

Implemented in dunedaq::timing::EndpointNode.

endpoint_ready()

bool dunedaq::timing::EndpointNodeInterface::endpoint_ready ( ) const

virtual

Get endpoint ready flag.

Returns

{ description_of_the_return_value }

Definition at line 30 of file EndpointNodeInterface.cpp.

{
  auto ready_flag = getNode("csr.stat.ep_rdy").read();
  getClient().dispatch();
  return ready_flag.value();
}

get_info()

virtual void dunedaq::timing::EndpointNodeInterface::get_info ( timingendpointinfo::TimingEndpointInfo & ) const

inlinevirtual

Collect monitoring information for timing endpoint.

Reimplemented in dunedaq::timing::EndpointNode.

Definition at line 80 of file EndpointNodeInterface.hpp.

{}

read_endpoint_state()

uint32_t dunedaq::timing::EndpointNodeInterface::read_endpoint_state ( ) const

virtual

Get endpoint state.

Returns

{ description_of_the_return_value }

Definition at line 40 of file EndpointNodeInterface.cpp.

{
  auto endpoint_state = getNode("csr.stat.ep_stat").read();
  getClient().dispatch();
  return endpoint_state.value();
}

reset()

virtual void dunedaq::timing::EndpointNodeInterface::reset ( uint32_t address = 0, uint32_t partition = 0 ) const

pure virtual

Reset the endpoint.

Returns

{ description_of_the_return_value }

Implemented in dunedaq::timing::EndpointNode.

---

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

• /github/workspace/dunedaq/sourcecode/timing/include/timing/EndpointNodeInterface.hpp
• /github/workspace/dunedaq/sourcecode/timing/src/EndpointNodeInterface.cpp