Home Libraries Author Links

stm::tools::MsgTimestamp Class Reference
[MsgTimestamp: Message Timestamp Model]

List of all members.


Detailed Description

Message timestamp type.

Definition at line 105 of file msgtimestamp.hpp.


Public Types

enum  
 Timestamp status. More...

Public Member Functions

 MsgTimestamp ()
 The default constructor constructs an invalid object.
void assign (word bfn, dword boardTimeSec, word boardTimeMs, dword seqNo)
 Assign UDP timing data.
void assign (word bfn, byte slot, word chip, bool hsTadsib=false)
 Assign FPGA or hsTADSIB FPGA timing data.
bool valid () const
 Return true, if this MsgTimestamp is valid, else false.
bool isUdp () const
 Return true, if this MsgTimestamp represents UDP timing data, else false.
bool isFpga () const
 Return true, if this MsgTimestamp represents FPGA or hsTADSIB FPGA.
byte status () const
 Return the status of this MsgTimestamp.
word bfn () const
 Return the BFN of this MsgTimestamp.
byte slot () const
 Return the slot of this MsgTimestamp.
word chip () const
 Return the chip of this MsgTimestamp.
dword boardTimeSec () const
 Return the board time seconds of this MsgTimestamp.
word boardTimeMs () const
 Return the board time milliseconds of this MsgTimestamp.
dword seqNo () const
 Return the sequence number of this MsgTimestamp.
bool hsTadsib () const
 Return true, if this MsgTimestamp represents hsTADSIB FPGA timing data, else false.

Member Enumeration Documentation

anonymous enum

Timestamp status.

Definition at line 109 of file msgtimestamp.hpp.


Constructor & Destructor Documentation

stm::tools::MsgTimestamp::MsgTimestamp (  ) 

The default constructor constructs an invalid object.


Member Function Documentation

void stm::tools::MsgTimestamp::assign ( word  bfn,
dword  boardTimeSec,
word  boardTimeMs,
dword  seqNo 
)

Assign UDP timing data.

void stm::tools::MsgTimestamp::assign ( word  bfn,
byte  slot,
word  chip,
bool  hsTadsib = false 
)

Assign FPGA or hsTADSIB FPGA timing data.

bool stm::tools::MsgTimestamp::valid (  )  const

Return true, if this MsgTimestamp is valid, else false.

bool stm::tools::MsgTimestamp::isUdp (  )  const

Return true, if this MsgTimestamp represents UDP timing data, else false.

bool stm::tools::MsgTimestamp::isFpga (  )  const

Return true, if this MsgTimestamp represents FPGA or hsTADSIB FPGA.

byte stm::tools::MsgTimestamp::status (  )  const

Return the status of this MsgTimestamp.

word stm::tools::MsgTimestamp::bfn (  )  const

Return the BFN of this MsgTimestamp.

byte stm::tools::MsgTimestamp::slot (  )  const

Return the slot of this MsgTimestamp.

Meaningful only for UDP timing data.

word stm::tools::MsgTimestamp::chip (  )  const

Return the chip of this MsgTimestamp.

Meaningful only for UDP timing data.

dword stm::tools::MsgTimestamp::boardTimeSec (  )  const

Return the board time seconds of this MsgTimestamp.

Meaningful only for FPGA or hsTADSIB FPGA timing data.

word stm::tools::MsgTimestamp::boardTimeMs (  )  const

Return the board time milliseconds of this MsgTimestamp.

Meaningful only for FPGA or hsTADSIB FPGA timing data.

dword stm::tools::MsgTimestamp::seqNo (  )  const

Return the sequence number of this MsgTimestamp.

Meaningful only for FPGA or hsTADSIB FPGA timing data.

bool stm::tools::MsgTimestamp::hsTadsib (  )  const

Return true, if this MsgTimestamp represents hsTADSIB FPGA timing data, else false.


© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).