NSCL DAQ Software Documentation
PrevNext

CDataFomatItem

Name

CDataFomatItem -- Describe the format of a stream of ringitems.

Synopsis


#include <CDataFormatItem.h>
        
 class CDataFormatItem : public CRingItem {
}

            
  CDataFormatItem();
            
  virtual ~CDataFormatItem();
              CDataFormatItem(const  CDataFormatItem& rhs);
              CDataFormatItem(const  CRingItem& rhs)
          throws std::bad_cast;
            
  CDataFormatItem& operator=(const CDataFormatItem& rhs);
              CDataFormatItem& operator=(const CRingItem& rhs)
          throws std::bad_cast;
              const int operator==(const CDataFormatItem& rhs);
              const int operator!=(const CDataFormatItem& rhs);
              const uint16_t major();
              const uint16_t minor();
              virtual const std::string typeName();
              virtual const std::string toString();
    };

DESCRIPTION

NoteNOTE:
 

This item is new as of version 11.0

The CDataFormatItem encapsulates a Ring item of type RING_FORMAT. This ring item provides information about the format of the stream of ring items to follow. It should be emitted by producers at the beginning of each coherent stream (run), so that downstream clients know how to parse the ring items that follow.

The item contains the major and minor version of the least recently released version of NSCDAQ capable of processing the item completely.

METHODS

CDataFormatItem();

Constructs a ring format item. The major and minor versions of the format are set to the values of FORMAT_MAJOR and FORMAT_MINOR in DataFormat.h for the version of the libdataformat.so library the program has loaded.

virtual ~CDataFormatItem();

Destructor

CDataFormatItem(const CDataFormatItem& rhs);

Copy constructs another CDataForamtItem making an object that is identical to rhs

CDataFormatItem(const CRingItem& rhs) throws std::bad_cast;

Constructs a CDataFormatItem by copying a CRingItem that is the rhs parameter. If rhs is not a RING_FORMAT type ring item a std::bad_cast exception is thrown.

CDataFormatItem& operator=(const CDataFormatItem& rhs);

Assignment operator. This allows one CDataFormatItem to be assigned from another right hand side (rhs).

CDataFormatItem& operator=(const CRingItem& rhs) throws std::bad_cast;

Assignment operator from a rhs operand that is an undifferentiated CRingItem. If the rhs's type is no RING_FORMAT, a std::bad_cast exception is thrown.

const int operator==(const CDataFormatItem& rhs);

Equality comparison. The rhs must be bit by bit equal to *this

const int operator!=(const CDataFormatItem& rhs);

Returns nonzero if operator== returns 0

const uint16_t major();

Returns the major version number field of the ring item.

const uint16_t minor();

Returns the minor version number field of the ring item.

virtual const std::string typeName();

Returns a text string that represents the item type of the ring itme. This is Ring Item format version

virtual const std::string toString();

Return a textual, human readable bit of text that dumps information about the ring item.

PrevHomeNext
CUnknownFragmentUpCGlomParameters