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_ts_epoch (TimestampEpoch ts_epoch) const
	Set epoch: UNIX/custom.
void	set_ts_epoch_value (uint64_t epoch_to_2000_seconds_tai, uint8_t epoch_to_2000_leap_seconds) const
	Set custom epoch value.
void	set_ts_timebase (TimestampTimebase ts_timebase) const
	Set custom epoch date.
void	set_ts_seconds_offset (int8_t seconds_offset) const
	Set seconds offset.
void	set_ts_ticks_offset (int16_t ticks_offset) const
	Set ticks offset.
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");
 
  auto sbs_subnodes = read_sub_nodes(getNode("csr.irig_sbs"));
  status << format_reg_table(sbs_subnodes, "IRIG SBS");
 
  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 115 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 65 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 125 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 76 of file IRIGTimestampNode.cpp.

{
  return tstamp2int(read_raw_timestamp());
}

set_ts_epoch()

void dunedaq::timing::IRIGTimestampNode::set_ts_epoch

(

TimestampEpoch

ts_epoch

)

const

Set epoch: UNIX/custom.

Definition at line 93 of file IRIGTimestampNode.cpp.

{
  getNode("csr.ctrl.ts_epoch").write(epoch);
  getClient().dispatch();
}

set_ts_epoch_value()

void dunedaq::timing::IRIGTimestampNode::set_ts_epoch_value	(	uint64_t	epoch_to_2000_seconds_tai,
		uint8_t	epoch_to_2000_leap_seconds ) const

Set custom epoch value.

Definition at line 102 of file IRIGTimestampNode.cpp.

{
  uint32_t epoch_l = epoch_to_2000_seconds_tai;
  uint32_t epoch_h = epoch_to_2000_seconds_tai >> 32;
  getNode("csr.seconds_from_sw_epoch_l").write(epoch_l);
  getNode("csr.seconds_from_sw_epoch_h").write(epoch_h);
  getNode("csr.offsets.leap_seconds_from_sw_epoch").write(epoch_to_2000_leap_seconds);
  getClient().dispatch();
}

set_ts_seconds_offset()

void dunedaq::timing::IRIGTimestampNode::set_ts_seconds_offset

(

int8_t

seconds_offset

)

const

Set seconds offset.

Definition at line 135 of file IRIGTimestampNode.cpp.

{
  // cast to uint8_t to avoid erroneous auto conversion
  getNode("csr.offsets.seconds_offset").write((uint8_t)seconds_offset);
  getClient().dispatch();
}

set_ts_ticks_offset()

void dunedaq::timing::IRIGTimestampNode::set_ts_ticks_offset

(

int16_t

ticks_offset

)

const

Set ticks offset.

Definition at line 145 of file IRIGTimestampNode.cpp.

{
  // cast to uint16_t to avoid erroneous auto conversion
  getNode("csr.offsets.ticks_offset").write((uint16_t)ticks_offset); // NOLINT(build/unsigned)
  getClient().dispatch();
}

set_ts_timebase()

void dunedaq::timing::IRIGTimestampNode::set_ts_timebase

(

TimestampTimebase

ts_timebase

)

const

Set custom epoch date.

Set timebase: TAI/UTC

Definition at line 84 of file IRIGTimestampNode.cpp.

{
  getNode("csr.ctrl.ts_timebase").write(timebase);
  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