The RawDataBlockFormat class Format information for rawdata handling. More...

#include <RawDataBlockFormat.h>

Inheritance diagram for RawDataBlockFormat:

Public Types
enum	{ POS_NWORDS = 0 , POS_NODE_ID = 6 }

enum	{ POS_FTSW_ID_OLD = 5 , TEMP_POS_NWORDS_HEADER = 1 , OLD_FTSW_NWORDS_HEADER = 6 }

Public Member Functions
	RawDataBlockFormat ()
	Default constructor.

virtual	~RawDataBlockFormat ()
	Destructor.

virtual void	SetBuffer (int *bufin, int nwords, int delete_flag, int num_events, int num_nodes)
	set buffer ( delete_flag : m_buffer is freeed( = 0 )/ not freeed( = 1 ) in Destructer )

virtual int	TotalBufNwords ()
	Get total length of m_buffer.

virtual int	GetBufferPos (int n)
	get position of data block in word

virtual int *	GetBuffer (int n)
	get nth buffer pointer

virtual int *	GetWholeBuffer ()
	get pointer to buffer(m_buffer)

virtual int	GetNumEntries ()
	get # of data blocks = (# of nodes)*(# of events)

virtual int	GetNumNodes ()
	get # of data sources(e.g. # of COPPER boards) in m_buffer

virtual int	GetNumEvents ()
	get # of events in m_buffer

virtual int	GetPreAllocFlag ()
	get malloc_flag

virtual int	GetBlockNwords (int n)
	get size of a data block

virtual int	CheckFTSWID (int n)
	get FTSW ID to check whether this data block is FTSW data or not

virtual int	CheckTLUID (int n)
	get FTSW ID to check whether this data block is FTSW data or not

virtual void	CopyBlock (int n, int *buf_to)
	Copy one datablock to buffer.

virtual void	PrintData (int *buf, int nwords)
	print data

Protected Attributes
int	m_nwords
	number of words of buffer

int	m_num_nodes
	number of nodes in this object

int	m_num_events
	number of events in this object

int *	m_buffer
	Buffer.

int	m_use_prealloc_buf
	not recorded

Detailed Description

The RawDataBlockFormat class Format information for rawdata handling.

Definition at line 25 of file RawDataBlockFormat.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Definition at line 75 of file RawDataBlockFormat.h.

         {
      POS_NWORDS = 0,
      POS_NODE_ID = 6
    };

◆ anonymous enum

anonymous enum

Definition at line 80 of file RawDataBlockFormat.h.

         {
      // Tentatively needed to distinguish new and old FTSW format, which will be changed in Nov. 2013
      POS_FTSW_ID_OLD = 5,
      TEMP_POS_NWORDS_HEADER = 1,
      OLD_FTSW_NWORDS_HEADER = 6
    };

Constructor & Destructor Documentation

◆ RawDataBlockFormat()

RawDataBlockFormat ( )

Default constructor.

Definition at line 14 of file RawDataBlockFormat.cc.

{
  m_nwords = 0;
  m_use_prealloc_buf = 0;
  m_buffer = NULL;
  m_num_nodes = 0;
  m_num_events = 0;
}

◆ ~RawDataBlockFormat()

~RawDataBlockFormat ( )

virtual

Destructor.

Definition at line 23 of file RawDataBlockFormat.cc.

{
  if (!m_use_prealloc_buf && m_buffer != NULL) {
    delete[] m_buffer;
  }
}

Member Function Documentation

◆ CheckFTSWID()

int CheckFTSWID ( int n )

virtual

get FTSW ID to check whether this data block is FTSW data or not

Definition at line 73 of file RawDataBlockFormat.cc.

{
  int pos = POS_NODE_ID;
  if (m_buffer[ GetBufferPos(n) + TEMP_POS_NWORDS_HEADER ] == OLD_FTSW_NWORDS_HEADER) {
    pos =  POS_FTSW_ID_OLD;
  }
 
  if ((m_buffer[ GetBufferPos(n) + pos ] & 0xffffff00) == 0x54544400) {     // "TTD" + format version ( 0x20=DESY, 0x31=2018/7/11)
    return 1;
  } else {
    return 0;
  }
}

◆ CheckTLUID()

int CheckTLUID ( int n )

virtual

get FTSW ID to check whether this data block is FTSW data or not

Definition at line 88 of file RawDataBlockFormat.cc.

{
  int pos = POS_NODE_ID;
  if (m_buffer[ GetBufferPos(n) + TEMP_POS_NWORDS_HEADER ] == OLD_FTSW_NWORDS_HEADER) {
    pos =  POS_FTSW_ID_OLD;
  }
  if (m_buffer[ GetBufferPos(n) + pos ] == 0x544c5520) { // "TLU "
    return 1;
  } else {
    return 0;
  }
}

◆ CopyBlock()

void CopyBlock	(	int	n,
		int *	buf_to
	)

virtual

Copy one datablock to buffer.

Definition at line 173 of file RawDataBlockFormat.cc.

{
  memcpy(buf_to, GetBuffer(n), GetBlockNwords(n) * sizeof(int));
  return;
}

◆ GetBlockNwords()

int GetBlockNwords ( int n )

virtual

get size of a data block

Definition at line 107 of file RawDataBlockFormat.cc.

{
  int size;
  if (n == (m_num_events * m_num_nodes) - 1) {
    size =  m_nwords - GetBufferPos(n);
  } else {
    size = GetBufferPos(n + 1) - GetBufferPos(n);
  }
  return size;
}

◆ GetBuffer()

int * GetBuffer ( int n )

virtual

get nth buffer pointer

Definition at line 124 of file RawDataBlockFormat.cc.

{
  int pos_nwords = GetBufferPos(n);
  return &(m_buffer[ pos_nwords ]);
}

◆ GetBufferPos()

int GetBufferPos ( int n )

virtual

get position of data block in word

Definition at line 30 of file RawDataBlockFormat.cc.

{
  if (m_buffer == NULL || m_nwords <= 0) {
    char err_buf[500];
    sprintf(err_buf, "[FATAL] RawPacket buffer(%p) is not available or length(%d) is not set.\n %s %s %d\n",
            m_buffer, m_nwords, __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  if (n >= (m_num_events * m_num_nodes)) {
    char err_buf[500];
    sprintf(err_buf, "[FATAL] Invalid COPPER block No. (%d : max %d ) is specified. Exiting... \n %s %s %d\n",
            n, (m_num_events * m_num_nodes), __FILE__, __PRETTY_FUNCTION__, __LINE__);
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  int pos_nwords = 0;
  for (int i = 1; i <= n ; i++) {
    if (m_buffer[ pos_nwords ] <= 0) {
      char err_buf[500];
      sprintf(err_buf,
              "[FATAL] ERROR_EVENT : length of this data block is strange ( %d words ). Maybe data is corrupted or RawHeader info has not been filled yet. Exiting...",
              m_buffer[ pos_nwords ]);
      printf("%s", err_buf);
      B2FATAL(err_buf);
    } else {
      pos_nwords +=      m_buffer[ pos_nwords ];
    }
    if (pos_nwords >= m_nwords) {
      char err_buf[500];
      sprintf(err_buf, "[FATAL] ERROR_EVENT : value of pos_nwords(%d) is larger than m_nwords(%d). Exiting...\n %s %s %d\n",
              pos_nwords, m_nwords, __FILE__, __PRETTY_FUNCTION__, __LINE__);
      printf("%s", err_buf); fflush(stdout);
      B2FATAL(err_buf); // to reduce multiple error messages
    }
  }
  return pos_nwords;
 
}

◆ GetNumEntries()

virtual int GetNumEntries ( )

inlinevirtual

get # of data blocks = (# of nodes)*(# of events)

Definition at line 49 of file RawDataBlockFormat.h.

49{ return m_num_events * m_num_nodes; }

◆ GetNumEvents()

virtual int GetNumEvents ( )

inlinevirtual

get # of events in m_buffer

Definition at line 55 of file RawDataBlockFormat.h.

55{ return m_num_events; }

◆ GetNumNodes()

virtual int GetNumNodes ( )

inlinevirtual

get # of data sources(e.g. # of COPPER boards) in m_buffer

Definition at line 52 of file RawDataBlockFormat.h.

52{ return m_num_nodes; }

◆ GetPreAllocFlag()

virtual int GetPreAllocFlag ( )

inlinevirtual

get malloc_flag

Definition at line 58 of file RawDataBlockFormat.h.

58{ return m_use_prealloc_buf; }

◆ GetWholeBuffer()

int * GetWholeBuffer ( )

virtual

get pointer to buffer(m_buffer)

Definition at line 119 of file RawDataBlockFormat.cc.

{
  return m_buffer;
}

◆ PrintData()

void PrintData	(	int *	buf,
		int	nwords
	)

virtual

print data

Definition at line 161 of file RawDataBlockFormat.cc.

{
  printf("[DEBUG] ");
  for (int i = 0; i < nwords; i++) {
    printf("%.8x ", buf[ i ]);
    if (i % 10 == 9) printf("\n[DEBUG] ");
  }
  printf("\n[DEBUG] ");
  printf("\n");
  return;
}

◆ SetBuffer()

void SetBuffer	(	int *	bufin,
		int	nwords,
		int	delete_flag,
		int	num_events,
		int	num_nodes
	)

virtual

set buffer ( delete_flag : m_buffer is freeed( = 0 )/ not freeed( = 1 ) in Destructer )

Definition at line 131 of file RawDataBlockFormat.cc.

{
 
  if (bufin == NULL) {
    char err_buf[500];
    sprintf(err_buf, "[DEBUG] bufin is NULL. Exting...\n");
    printf("%s", err_buf); fflush(stdout);
    B2FATAL(err_buf);
  }
 
  if (!m_use_prealloc_buf && m_buffer != NULL) delete[] m_buffer;
 
  if (delete_flag == 0) {
    m_use_prealloc_buf = true;
  } else {
    m_use_prealloc_buf = false;
  }
 
  m_nwords = nwords;
  m_buffer = bufin;
 
  m_num_nodes = num_nodes;
  m_num_events = num_events;
 
  return;
 
}

◆ TotalBufNwords()

int TotalBufNwords ( )

virtual

Get total length of m_buffer.

Definition at line 101 of file RawDataBlockFormat.cc.

{
  return m_nwords;
}

Member Data Documentation

◆ m_buffer

int* m_buffer

protected

Buffer.

Definition at line 98 of file RawDataBlockFormat.h.

◆ m_num_events

int m_num_events

protected

number of events in this object

Definition at line 95 of file RawDataBlockFormat.h.

◆ m_num_nodes

int m_num_nodes

protected

number of nodes in this object

Definition at line 92 of file RawDataBlockFormat.h.

◆ m_nwords

int m_nwords

protected

number of words of buffer

Definition at line 89 of file RawDataBlockFormat.h.

◆ m_use_prealloc_buf

int m_use_prealloc_buf

protected

not recorded

flag for deleting m_buffer in destructer( 0:delete, 1: not delete) When using pre-allocated buffer, the buffer should be reused and not deleted in the destructer

Definition at line 102 of file RawDataBlockFormat.h.

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

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ RawDataBlockFormat()

◆ ~RawDataBlockFormat()

Member Function Documentation

◆ CheckFTSWID()

◆ CheckTLUID()

◆ CopyBlock()

◆ GetBlockNwords()

◆ GetBuffer()

◆ GetBufferPos()

◆ GetNumEntries()

◆ GetNumEvents()

◆ GetNumNodes()

◆ GetPreAllocFlag()

◆ GetWholeBuffer()

◆ PrintData()

◆ SetBuffer()

◆ TotalBufNwords()

Member Data Documentation

◆ m_buffer

◆ m_num_events

◆ m_num_nodes

◆ m_nwords

◆ m_use_prealloc_buf