CDataFormatItem (v11)

Name

CDataFormatItem (v11) -- Provide the format version of subsequent data

Synopsis


#include <v11/CDataFormatITem.h>

namespace v11 {

/
class CDataFormatItem : public ::CDataFormatItem
{
    // Canonical methods:
public:
    CDataFormatItem();
    virtual ~CDataFormatItem();
    
    virtual uint16_t getMajor() const;
    virtual uint16_t getMinor() const;
    
    virtual std::string typeName() const;
    virtual std::string toString() const;
    
    virtual bool hasBodyHeader() const;
    virtual void* getBodyHeader() const;
    virtual void setBodyHeader(uint64_t timestamp, uint32_t sourceId,
                         uint32_t barrierType = 0);
    
    
    
};
}
                

DESCRIPTION

At the beginning of a run acquired in NSCLDAQ-11, A data format item is emitted specifying that the data format is that of NSCLDAQ-11. These items, in addition to a ring item header and an indicator that there is no body header, contain a major and minor version number.

In practice the minor version number is 0 and is not important for decoding ring items.

METHODS

CDataFormatItem();

The constructor fills in the item with the major and minor vesions that define the data format.

const virtual uint16_t getMajor ();

Returns the major version of the data format. In practice, this is sufficient to establish the data format.

const virtual uint16_t getMinor();

Returns the minor version of the data format. In practice this is seldom necessary.

const virtual std::string typeName();

Return the string: Ring Item format version

const virtual std::string toString();

Returns a human readable string that describes the contents of the ring item.

const virtual void* getBodyHeader();

Returns nullptr since these items never have a body header.

virtual void setBodyHeader(uint64_t timestamp, uint32_t sourceId, uint32_t barrierType = 0);

No-op since these items don't have body headers.