The Raw Header class ver.1 ( the latest version since May, 2014 ) This class defines the format of the header of RawCOPPER class data and used for extracting header info from RawCOPPER object. More...

#include <RawHeader_latest.h>

Public Types
enum	{ MAGIC_WORD = 0x7F7F0000 , MAGIC_MASK = 0xFFFF0000 , MAGIC_SHIFT = 16 , FORMAT_VERSION__MASK = 0x0000FF00 , FORMAT_VERSION_SHIFT = 8 }

enum	{ EXP_MASK = 0xFFC00000 , EXP_SHIFT = 22 , RUNNO_MASK = 0x003FFF00 , RUNNO_SHIFT = 8 , SUBRUNNO_MASK = 0x000000FF }

enum	{ RAWHEADER_NWORDS = 56 }

enum	{ HDR_NWORDS_MASK = 0x000000FF }

enum	{ POS_NWORDS = 0 , POS_VERSION_HDRNWORDS = 1 , POS_EXP_RUN_NO = 2 , POS_EVE_NO = 3 , POS_TTCTIME_TRGTYPE = 4 , POS_TTUTIME = 5 , POS_NODE_ID = 6 , POS_TRUNC_MASK_DATATYPE = 7 , POS_CH_POS_TABLE = 8 }

enum	{ TTCTIME_MASK = 0x7FFFFFF0 , TTCTIME_SHIFT = 4 , TRGTYPE_MASK = 0xF }

enum	{ B2LINK_PACKET_CRC_ERROR = 0x1 , B2LINK_EVENT_CRC_ERROR = 0x2 }

Public Member Functions
	RawHeader_latest ()
	Default constructor.

	RawHeader_latest (int *)
	Constructor using existing pointer to raw data buffer.

	~RawHeader_latest ()
	Destructor.

int *	GetBuffer ()
	Get header contents.

void	SetBuffer (int *bufin)
	set buffer

void	CheckSetBuffer ()
	initialize header

void	CheckGetBuffer ()
	check if m_buffer exists

void	SetNwords (int nwords)
	set contents of header

void	SetEveNo (unsigned int eve_no)
	set contents of header

void	SetNodeID (unsigned int node_id)
	set contents of header

void	SetDataType (int data_type)
	set contents of header

void	SetTruncMask (int trunc_mask)
	set contents of header

void	SetFTSW2Words (unsigned int word1, unsigned int word2)
	Set values of FTSW info( trigger timing)

void	SetExpRunNumber (int *exprun_buf)
	Set a word consists of exp #, run # and subrun #.

void	SetOffset1stFINESSE (int offset_1st_FINESSE)
	set contents of header

void	SetOffset2ndFINESSE (int offset_2nd_FINESSE)
	set contents of header

void	SetOffset3rdFINESSE (int offset_3rd_FINESSE)
	set contents of header

void	SetOffset4thFINESSE (int offset_4th_FINESSE)
	set contents of header

int	GetNwords ()
	set contents of header

int	GetHdrNwords ()
	get contents of header

unsigned int	GetExpRunSubrun ()
	get contents of header

int	GetExpNo ()
	get a run/exp number combined word

int	GetRunNo ()
	get contents of header

int	GetSubRunNo ()
	get run # (14bit)

unsigned int	GetEveNo ()
	get restart #(8bit)

unsigned int	GetNodeID ()
	get contents of header

int	GetDataType ()
	get contents of header

int	GetTruncMask ()
	get contents of header

unsigned int	GetErrorBitFlag ()
	get contents of header

void	AddErrorBitFlag (unsigned int error_bit_flag)
	Add Detected Error bitflag.

int	GetPacketCRCError ()
	Get Packet CRC error flag.

int	GetEventCRCError ()
	Get Detected Error bitflag.

int	GetOffset1stFINESSE ()
	get contents of header

int	GetOffset2ndFINESSE ()
	get contents of header

int	GetOffset3rdFINESSE ()
	get contents of header

int	GetOffset4thFINESSE ()
	get contents of header

unsigned int	GetTTCtimeTRGType ()
	get contents of header

int	GetTTCtime ()
	get contents of header

int	GetTRGType ()
	get TRGType

unsigned int	GetTTUtime ()
	get contents of header

void	GetTTTimeVal (struct timeval *tv)
	get contents of header

void	CheckHeader (int *buf)
	Get magic word to check the data corruption.

Private Attributes
int *	m_buffer
	do not record buffer ( RawCOPPER includes buffer of RawHeader_latest and RawTrailer )

Detailed Description

The Raw Header class ver.1 ( the latest version since May, 2014 ) This class defines the format of the header of RawCOPPER class data and used for extracting header info from RawCOPPER object.

Definition at line 32 of file RawHeader_latest.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Definition at line 165 of file RawHeader_latest.h.

         {
      MAGIC_WORD = 0x7F7F0000,
      MAGIC_MASK = 0xFFFF0000,
      MAGIC_SHIFT = 16,
      FORMAT_VERSION__MASK = 0x0000FF00,
      FORMAT_VERSION_SHIFT = 8
    };

◆ anonymous enum

anonymous enum

Definition at line 173 of file RawHeader_latest.h.

         {
      EXP_MASK = 0xFFC00000,
      EXP_SHIFT = 22,
      RUNNO_MASK = 0x003FFF00,
      RUNNO_SHIFT = 8,
      SUBRUNNO_MASK = 0x000000FF
    };

◆ anonymous enum

anonymous enum

Definition at line 181 of file RawHeader_latest.h.

         {
      RAWHEADER_NWORDS = 56
    };

◆ anonymous enum

anonymous enum

Definition at line 185 of file RawHeader_latest.h.

         {
      HDR_NWORDS_MASK = 0x000000FF
    };

◆ anonymous enum

anonymous enum

Definition at line 190 of file RawHeader_latest.h.

         {
      POS_NWORDS = 0,
      POS_VERSION_HDRNWORDS = 1,
      POS_EXP_RUN_NO = 2,
      POS_EVE_NO = 3,
      POS_TTCTIME_TRGTYPE = 4,
      POS_TTUTIME = 5,
      POS_NODE_ID = 6,
      POS_TRUNC_MASK_DATATYPE = 7,
      POS_CH_POS_TABLE = 8
    };

◆ anonymous enum

anonymous enum

Definition at line 218 of file RawHeader_latest.h.

         {
      TTCTIME_MASK = 0x7FFFFFF0,
      TTCTIME_SHIFT = 4,
      TRGTYPE_MASK = 0xF
    };

◆ anonymous enum

anonymous enum

Definition at line 226 of file RawHeader_latest.h.

         {
      B2LINK_PACKET_CRC_ERROR = 0x1,
      B2LINK_EVENT_CRC_ERROR = 0x2
    };

Constructor & Destructor Documentation

◆ RawHeader_latest() [1/2]

RawHeader_latest ( )

Default constructor.

Definition at line 16 of file RawHeader_latest.cc.

{
  m_buffer = NULL;
  //  initialize();
  //  cout << "RawHeader_latest NULL constructor" << endl;
}

◆ RawHeader_latest() [2/2]

RawHeader_latest ( int * buffer )

explicit

Constructor using existing pointer to raw data buffer.

Definition at line 23 of file RawHeader_latest.cc.

{
  m_buffer = buffer;
}

◆ ~RawHeader_latest()

~RawHeader_latest ( )

Destructor.

Definition at line 28 of file RawHeader_latest.cc.

29{

30}

Member Function Documentation

◆ CheckHeader()

void CheckHeader ( int * buf )

Get magic word to check the data corruption.

check the contents of header

Definition at line 58 of file RawHeader_latest.cc.

{
 
  // # of words
  if (buf[ POS_NWORDS ] > 2.5e7 || buf[ POS_NWORDS ] < RAWHEADER_NWORDS) {
    char err_buf[500];
    sprintf(err_buf, "data size error %d words. Exiting... : %s %s %d\n",
            buf[ POS_NWORDS ], __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  // # of words in this block
  if ((buf[ POS_VERSION_HDRNWORDS ] & HDR_NWORDS_MASK) != RAWHEADER_NWORDS) {
    char err_buf[500];
    sprintf(err_buf, "Invalid header size %d words should be %d. Exiting... : %s %s %d\n",
            buf[ buf[ POS_VERSION_HDRNWORDS ] & HDR_NWORDS_MASK ],
            RAWHEADER_NWORDS, __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  //  exp. run #
 
  //  utime( 2010 1/1 - 2050 1/1 )
  if ((unsigned int)(buf[ POS_TTUTIME ]) < (unsigned int)0x4b3cbc70 ||
      (unsigned int)0x9679f770 < (unsigned int)(buf[ POS_TTUTIME ])) {
    char err_buf[500];
    sprintf(err_buf, "Invalid utime %d . Exiting...: %s %s %d\n",
            buf[ POS_TTUTIME ], __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  // truncation mask
 
  int ch = 0;
  // offset
  if (buf[ POS_CH_POS_TABLE + ch ] < RAWHEADER_NWORDS) {
    char err_buf[500];
    sprintf(err_buf, "Invalid data offset for ch(=%d) finesse buffer(%d). Exiting...: %s %s %d\n",
            ch, buf[ POS_CH_POS_TABLE + ch ], __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  for (int i = 1; i < (MAX_PCIE40_CH - 1); i++) {
    ch = i;
    if (buf[ POS_CH_POS_TABLE + ch ] < buf[ POS_CH_POS_TABLE + (ch - 1) ]) {
      char err_buf[500];
      sprintf(err_buf, "Invalid data offset for ch(=%d) finesse buffer(%d). Exiting...: %s %s %d\n",
              ch, buf[ POS_CH_POS_TABLE + ch ], __FILE__, __PRETTY_FUNCTION__, __LINE__);
      printf("%s", err_buf); fflush(stdout);
      B2FATAL(err_buf);
    }
  }
  ch = MAX_PCIE40_CH - 1;
 
  if (buf[ POS_CH_POS_TABLE + ch ] < buf[ POS_CH_POS_TABLE + (ch - 1) ] ||
      buf[ POS_CH_POS_TABLE + ch ] > buf[ POS_NWORDS ]) {
    char err_buf[500];
    sprintf(err_buf, "Invalid data offset for ch(=%d) finesse buffer(%d). Exiting...: %s %s %d\n",
            ch, buf[ POS_CH_POS_TABLE + ch ], __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
  return;
}

◆ GetBuffer()

int * GetBuffer ( )

inline

Get header contents.

Definition at line 44 of file RawHeader_latest.h.

44{ return m_buffer; }

◆ GetOffset1stFINESSE()

int GetOffset1stFINESSE ( )

get contents of header

Definition at line 163 of file RawHeader_latest.cc.

{
  char err_buf[500];
  sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("[DEBUG] %s\n", err_buf);
  B2FATAL(err_buf);
  return 0;
}

◆ GetOffset2ndFINESSE()

int GetOffset2ndFINESSE ( )

get contents of header

Definition at line 173 of file RawHeader_latest.cc.

{
  char err_buf[500];
  sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("[DEBUG] %s\n", err_buf);
  B2FATAL(err_buf);
  return 0;
}

◆ GetOffset3rdFINESSE()

int GetOffset3rdFINESSE ( )

get contents of header

Definition at line 183 of file RawHeader_latest.cc.

{
  char err_buf[500];
  sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("[DEBUG] %s\n", err_buf);
  B2FATAL(err_buf);
  return 0;
}

◆ GetOffset4thFINESSE()

int GetOffset4thFINESSE ( )

get contents of header

Definition at line 193 of file RawHeader_latest.cc.

{
  char err_buf[500];
  sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("[DEBUG] %s\n", err_buf);
  B2FATAL(err_buf);
  return 0;
}

◆ SetBuffer()

void SetBuffer ( int * bufin )

inline

set buffer

Definition at line 47 of file RawHeader_latest.h.

47{ m_buffer = bufin; }

◆ SetOffset1stFINESSE()

void SetOffset1stFINESSE ( int offset_1st_FINESSE )

set contents of header

Definition at line 127 of file RawHeader_latest.cc.

{
  char err_buf[500];
  sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("[DEBUG] %s\n", err_buf);
  B2FATAL(err_buf);
}

◆ SetOffset2ndFINESSE()

void SetOffset2ndFINESSE ( int offset_2nd_FINESSE )

set contents of header

Definition at line 136 of file RawHeader_latest.cc.

{
  char err_buf[500];
  sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("[DEBUG] %s\n", err_buf);
  B2FATAL(err_buf);
}

◆ SetOffset3rdFINESSE()

void SetOffset3rdFINESSE ( int offset_3rd_FINESSE )

set contents of header

Definition at line 145 of file RawHeader_latest.cc.

{
  char err_buf[500];
  sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("[DEBUG] %s\n", err_buf);
  B2FATAL(err_buf);
}

◆ SetOffset4thFINESSE()

void SetOffset4thFINESSE ( int offset_4th_FINESSE )

set contents of header

Definition at line 154 of file RawHeader_latest.cc.

{
  char err_buf[500];
  sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
          __FILE__, __PRETTY_FUNCTION__, __LINE__);
  printf("[DEBUG] %s\n", err_buf);
  B2FATAL(err_buf);
}

Member Data Documentation

◆ m_buffer

int* m_buffer

private

do not record buffer ( RawCOPPER includes buffer of RawHeader_latest and RawTrailer )

Definition at line 233 of file RawHeader_latest.h.

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

rawdata/dataobjects/include/RawHeader_latest.h
rawdata/dataobjects/src/RawHeader_latest.cc

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ RawHeader_latest() [1/2]

◆ RawHeader_latest() [2/2]

◆ ~RawHeader_latest()

Member Function Documentation

◆ CheckHeader()

◆ GetBuffer()

◆ GetOffset1stFINESSE()

◆ GetOffset2ndFINESSE()

◆ GetOffset3rdFINESSE()

◆ GetOffset4thFINESSE()

◆ SetBuffer()

◆ SetOffset1stFINESSE()

◆ SetOffset2ndFINESSE()

◆ SetOffset3rdFINESSE()

◆ SetOffset4thFINESSE()

Member Data Documentation

◆ m_buffer