KM3NETDAQ::JDAQUTCExtended Class Reference

Data structure for UTC time. More...

#include <JDAQUTCExtended.hh>

Inheritance diagram for KM3NETDAQ::JDAQUTCExtended:

Public Member Functions
	JDAQUTCExtended ()
	Default constructor. More...
	JDAQUTCExtended (const uint32_t seconds, const uint32_t cycles)
	Constructor. More...
	JDAQUTCExtended (const double nanoseconds)
	Constructor. More...
virtual	~JDAQUTCExtended ()
	Virtual destructor. More...
bool	getWRStatus () const
	Get White Rabbit status. More...
uint32_t	getUTCseconds () const
	Get major time. More...
uint32_t	getUTC16nanosecondcycles () const
	Get minor time. More...
double	getTimeNanoSecond () const
	Get time (limited to 16 ns cycles). More...
void	setTimeNanoSecond (const double utc_ns)
	Set time. More...
void	addTimeNanoSecond (const double t_ns)
	Add time. More...
	ClassDef (JDAQUTCExtended, 1)

Static Public Member Functions
static JDAQUTCExtended	min ()
	Get minimum possible value. More...
static JDAQUTCExtended	max ()
	Get maximum possible value. More...
static uint32_t	getMask ()
	Get mask for seconds data. More...
static double	getTick ()
	Get number of nano-seconds per tick. More...
static const JDAQUTCExtended &	getInstance ()
	Get arbitrary offset (e.g. More...

Protected Attributes
uint32_t	UTC_seconds
uint32_t	UTC_16nanosecondcycles

Friends
size_t	getSizeof ()
	Definition of method to get size of data type. More...
JReader &	operator>> (JReader &, JDAQUTCExtended &)
	Read UTC from input. More...
JWriter &	operator<< (JWriter &, const JDAQUTCExtended &)
	Write UTC to output. More...
std::istream &	operator>> (std::istream &in, JDAQUTCExtended &utc)
	Read UTC time. More...
std::ostream &	operator<< (std::ostream &out, const JDAQUTCExtended &utc)
	Write UTC time. More...

Detailed Description

Data structure for UTC time.

Definition at line 22 of file JDAQUTCExtended.hh.

Constructor & Destructor Documentation

JDAQUTCExtended() [1/3]

KM3NETDAQ::JDAQUTCExtended::JDAQUTCExtended ( )

inline

Default constructor.

Definition at line 34 of file JDAQUTCExtended.hh.

                      :
      UTC_seconds(0),
      UTC_16nanosecondcycles(0)
    {}

JDAQUTCExtended() [2/3]

KM3NETDAQ::JDAQUTCExtended::JDAQUTCExtended ( const uint32_t  seconds, const uint32_t  cycles  )

inline

Constructor.

Parameters

seconds	seconds [s]
cycles	cycles [16 ns]

Definition at line 46 of file JDAQUTCExtended.hh.

                                          :
      UTC_seconds(seconds),
      UTC_16nanosecondcycles(cycles)
    {}

JDAQUTCExtended() [3/3]

KM3NETDAQ::JDAQUTCExtended::JDAQUTCExtended ( const double  nanoseconds )

inline

Constructor.

Parameters

nanoseconds

time [ns]

Definition at line 58 of file JDAQUTCExtended.hh.

    {
      setTimeNanoSecond(nanoseconds);
    }

~JDAQUTCExtended()

virtual KM3NETDAQ::JDAQUTCExtended::~JDAQUTCExtended ( )

inlinevirtual

Virtual destructor.

Definition at line 67 of file JDAQUTCExtended.hh.

    {}

Member Function Documentation

getWRStatus()

bool KM3NETDAQ::JDAQUTCExtended::getWRStatus ( ) const

inline

Get White Rabbit status.

Returns

true if okay; else false

Definition at line 76 of file JDAQUTCExtended.hh.

    {
      return (UTC_seconds & ~getMask()) != 0;
    }

getUTCseconds()

uint32_t KM3NETDAQ::JDAQUTCExtended::getUTCseconds ( ) const

inline

Get major time.

Returns

time [s]

Definition at line 87 of file JDAQUTCExtended.hh.

    {
      return (UTC_seconds & getMask());
    }

getUTC16nanosecondcycles()

uint32_t KM3NETDAQ::JDAQUTCExtended::getUTC16nanosecondcycles ( ) const

inline

Get minor time.

Returns

time [16 ns]

Definition at line 98 of file JDAQUTCExtended.hh.

    {
      return UTC_16nanosecondcycles;
    }

getTimeNanoSecond()

double KM3NETDAQ::JDAQUTCExtended::getTimeNanoSecond ( ) const

inline

Get time (limited to 16 ns cycles).

Returns

time [ns]

Definition at line 109 of file JDAQUTCExtended.hh.

    {
      return getUTCseconds() * 1.0e9  +  getUTC16nanosecondcycles() * getTick();
    }

setTimeNanoSecond()

void KM3NETDAQ::JDAQUTCExtended::setTimeNanoSecond ( const double  utc_ns )

inline

Set time.

Parameters

utc_ns

time [ns]

Definition at line 120 of file JDAQUTCExtended.hh.

    {
      UTC_seconds            = (uint32_t) ( utc_ns * 1.0e-9);
      UTC_16nanosecondcycles = (uint32_t) ((utc_ns - UTC_seconds*1.0e9) / getTick());
    }

addTimeNanoSecond()

void KM3NETDAQ::JDAQUTCExtended::addTimeNanoSecond ( const double  t_ns )

inline

Add time.

Parameters

t_ns

time [ns]

Definition at line 132 of file JDAQUTCExtended.hh.

    {
      const double   x_ns  =  (double) getUTC16nanosecondcycles() * (double) getTick()  +  t_ns;
      const uint32_t t_s   =  (uint32_t) (x_ns * 1.0e-9);
      
      UTC_seconds            += t_s; 
      UTC_16nanosecondcycles  = (uint32_t) ((x_ns - t_s*1.0e9) / getTick());
    }

min()

static JDAQUTCExtended KM3NETDAQ::JDAQUTCExtended::min ( )

inlinestatic

Get minimum possible value.

Returns

minimum possible value

Definition at line 147 of file JDAQUTCExtended.hh.

    {
      return JDAQUTCExtended(0,0);
    }

max()

static JDAQUTCExtended KM3NETDAQ::JDAQUTCExtended::max ( )

inlinestatic

Get maximum possible value.

Returns

maximum possible value

Definition at line 158 of file JDAQUTCExtended.hh.

    {
      return JDAQUTCExtended(std::numeric_limits<uint32_t>::max(),
                             std::numeric_limits<uint32_t>::max());
    }

getMask()

static uint32_t KM3NETDAQ::JDAQUTCExtended::getMask ( )

inlinestatic

Get mask for seconds data.

Returns

mask

Definition at line 170 of file JDAQUTCExtended.hh.

    {
      return 0x7FFFFFFF;
    }

getTick()

static double KM3NETDAQ::JDAQUTCExtended::getTick ( )

inlinestatic

Get number of nano-seconds per tick.

Returns

time [ns]

Definition at line 181 of file JDAQUTCExtended.hh.

    {
      return 16.0;
    }

getInstance()

static const JDAQUTCExtended& KM3NETDAQ::JDAQUTCExtended::getInstance ( )

inlinestatic

Get arbitrary offset (e.g.

for accuracy of time differences).

Returns

UTC time

Definition at line 192 of file JDAQUTCExtended.hh.

    {
      static JDAQUTCExtended utc(1600000000, 0);
 
      return utc;
    }

ClassDef()

KM3NETDAQ::JDAQUTCExtended::ClassDef	(	JDAQUTCExtended	,
		1
	)

Friends And Related Function Documentation

getSizeof

size_t getSizeof ( )

friend

Definition of method to get size of data type.

This method should be specialised for each desired data type with fixed length.

Returns

number of bytes

operator>> [1/2]

JReader& operator>> ( JReader &  in, JDAQUTCExtended &  utc  )

friend

Read UTC from input.

Parameters

in	reader
utc	UTC

Returns

reader

Definition at line 33 of file JDAQUTCExtendedIO.hh.

  {
    in >> utc.UTC_seconds;
    in >> utc.UTC_16nanosecondcycles;
 
    return in;
  }

operator<< [1/2]

JWriter& operator<< ( JWriter &  out, const JDAQUTCExtended &  utc  )

friend

Write UTC to output.

Parameters

out	writer
utc	UTC

Returns

writer

Definition at line 49 of file JDAQUTCExtendedIO.hh.

  {
    out << utc.UTC_seconds;
    out << utc.UTC_16nanosecondcycles;
 
    return out;
  }

operator>> [2/2]

std::istream& operator>> ( std::istream &  in, JDAQUTCExtended &  utc  )

friend

Read UTC time.

Parameters

in	intput stream
utc	UTC extended time

Returns

intput stream

Definition at line 207 of file JDAQUTCExtended.hh.

    {
      in >> utc.UTC_seconds;
      in.get();
      in >> utc.UTC_16nanosecondcycles;
      
      return in;
    }

operator<< [2/2]

std::ostream& operator<< ( std::ostream &  out, const JDAQUTCExtended &  utc  )

friend

Write UTC time.

Parameters

out	output stream
utc	UTC extended time

Returns

output stream

Definition at line 224 of file JDAQUTCExtended.hh.

    {
      using namespace std;
      
      const char c = out.fill();
 
      out << setw(10) << utc.getUTCseconds();
      out << ':';
      out << setw(10) << setfill('0') << utc.getUTC16nanosecondcycles() << setfill(c);
      
      return out;
    }

Member Data Documentation

UTC_seconds

uint32_t KM3NETDAQ::JDAQUTCExtended::UTC_seconds

protected

Definition at line 242 of file JDAQUTCExtended.hh.

UTC_16nanosecondcycles

uint32_t KM3NETDAQ::JDAQUTCExtended::UTC_16nanosecondcycles

protected

Definition at line 243 of file JDAQUTCExtended.hh.

---

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

• JDAQUTCExtended.hh