dunedaq::timing::IRIGTimestampNode Class Reference

Class for timestamp generator node. More...

#include <IRIGTimestampNode.hpp>

Inheritance diagram for dunedaq::timing::IRIGTimestampNode:

Collaboration diagram for dunedaq::timing::IRIGTimestampNode:

Public Member Functions
	IRIGTimestampNode (const uhal::Node &node)
virtual	~IRIGTimestampNode ()
std::string	get_status (bool print_out=false) const override
	Print the status of the timing node.
uhal::ValVector< uint32_t >	read_raw_timestamp (bool dispatch=true) const
	Read the current timestamp words.
uint64_t	read_timestamp () const
	Read the current timestamp words.
void	set_irig_epoch (IRIGEpoch irig_epoch) const
	Set IRIG epoch: TAI/UNIX.
uint32_t	read_pps_counter () const
	Read the current pps ctr word.
uint64_t	read_seconds_since_epoch () const
	Read the current seconds since epoch words.
Public Member Functions inherited from dunedaq::timing::TimingNode
	TimingNode (const uhal::Node &node)
virtual	~TimingNode ()
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

Class for timestamp generator node.

Definition at line 33 of file IRIGTimestampNode.hpp.

Constructor & Destructor Documentation

IRIGTimestampNode()

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

explicit

Definition at line 22 of file IRIGTimestampNode.cpp.

  : TimingNode(node)
{}

~IRIGTimestampNode()

dunedaq::timing::IRIGTimestampNode::~IRIGTimestampNode ( )

virtual

Definition at line 28 of file IRIGTimestampNode.cpp.

{}

Member Function Documentation

get_status()

std::string dunedaq::timing::IRIGTimestampNode::get_status ( bool print_out = false ) const

overridevirtual

Print the status of the timing node.

Implements dunedaq::timing::TimingNode.

Definition at line 33 of file IRIGTimestampNode.cpp.

{
  std::stringstream status;
  status << "Timestamp: 0x" << std::hex << read_timestamp() << std::endl;
 
  auto ctrl_subnodes = read_sub_nodes(getNode("csr.ctrl"));
  status << format_reg_table(ctrl_subnodes, "IRIG ts ctrl");
 
  auto stat_subnodes = read_sub_nodes(getNode("csr.stat"));
  status << format_reg_table(stat_subnodes, "IRIG ts state");
 
  auto date_subnodes = read_sub_nodes(getNode("csr.irig_date"));
  status << format_reg_table(date_subnodes, "IRIG date");
 
  auto time_subnodes = read_sub_nodes(getNode("csr.irig_time"));
  status << format_reg_table(time_subnodes, "IRIG time");
 
  status << "PPS counter: 0x" << std::hex << read_pps_counter() << std::endl;
 
  status << "Seconds since epoch: 0x" << std::hex << read_seconds_since_epoch() << std::endl;
 
  if (print_out)
    TLOG() << status.str();
  return status.str();
}

read_pps_counter()

uint32_t dunedaq::timing::IRIGTimestampNode::read_pps_counter

(

)

const

Read the current pps ctr word.

Returns

{ description_of_the_return_value }

Definition at line 92 of file IRIGTimestampNode.cpp.

{
  auto counter = getNode("pps_ctr").read();
  getClient().dispatch();
  return counter.value();
}

read_raw_timestamp()

uhal::ValVector< uint32_t > dunedaq::timing::IRIGTimestampNode::read_raw_timestamp

(

bool

dispatch = true

)

const

Read the current timestamp words.

Returns

{ description_of_the_return_value }

Definition at line 62 of file IRIGTimestampNode.cpp.

{
  auto timestamp = getNode("tstamp").readBlock(2);
  if (dispatch)
    getClient().dispatch();
  return timestamp;
}

read_seconds_since_epoch()

uint64_t dunedaq::timing::IRIGTimestampNode::read_seconds_since_epoch

(

)

const

Read the current seconds since epoch words.

Returns

{ description_of_the_return_value }

Definition at line 102 of file IRIGTimestampNode.cpp.

{
  auto seconds_since_epoch = getNode("seconds_since_epoch").readBlock(2);
  getClient().dispatch();
  return tstamp2int(seconds_since_epoch);
}

read_timestamp()

uint64_t dunedaq::timing::IRIGTimestampNode::read_timestamp

(

)

const

Read the current timestamp words.

Returns

{ description_of_the_return_value }

Definition at line 73 of file IRIGTimestampNode.cpp.

{
  return tstamp2int(read_raw_timestamp());
}

set_irig_epoch()

void dunedaq::timing::IRIGTimestampNode::set_irig_epoch

(

IRIGEpoch

irig_epoch

)

const

Set IRIG epoch: TAI/UNIX.

Definition at line 81 of file IRIGTimestampNode.cpp.

{
  getNode("csr.ctrl.rst").write(0x1);
  getNode("csr.ctrl.irig_epoch").write(irig_epoch);
  getNode("csr.ctrl.rst").write(0x0);
  getClient().dispatch();
}

---

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

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