In This Package:

DybDaq::LtbFoot Class Reference

#include <LtbFoot.h>

Inheritance diagram for DybDaq::LtbFoot:

[legend]Collaboration diagram for DybDaq::LtbFoot:[legend]List of all members.

Public Types
typedef std::pair< const char *, unsigned int >	OutputBuffer
typedef std::vector< OutputBuffer >	OutputBufferList
typedef std::vector< ByteInspector * >	Bytes
typedef std::vector< BitsInspector * >	Bits
Public Member Functions
virtual	~LtbFoot ()
	Destroy this instance of the class.
unsigned int	dataLength () const
	Returns the data transfer length, in bytes, contained in this readout.
virtual unsigned int	bufferSize () const
	Returns the size, in 4-bytes, of this ojbect's contents in the buffer.
const LtbTraits &	ltbTraits () const
	Returns the LtbTraits instance used to parse this object's buffer.
bool	hasDaqTraits () const
virtual const DaqTraits &	daqTraits () const
virtual unsigned int	gather (OutputBufferList &outputBuffers) const
virtual unsigned int	inspect (DaqBuffer::Bytes &inspectors) const
Static Public Attributes
static const unsigned int	kBytesInInt
static const unsigned int	kUndefinedFormatComponent
Protected Member Functions
	LtbFoot (const LtbHead &head)
	Create an instance of this class.
	LtbFoot (const ByteBuffer &byteBuffer, const LtbTraits &traits)
	Create an instance of this class.
virtual unsigned int	formatComponent () const
	Returns the component with the format of this buffer.
const char *	buffer () const
char *	buffer ()
bool	hasByteBuffer () const
const ByteBuffer &	byteBuffer () const
unsigned int	fillInspectors (DaqBuffer::Bytes &inspectors, unsigned int component, unsigned int cursor) const
virtual bool	readBool (const unsigned int field) const
virtual int	readInt (const unsigned int field) const
virtual unsigned char	readUnsignedChar (const unsigned int field) const
virtual unsigned int	readUnsignedInt (const unsigned int field) const
virtual void	writeField (const bool value, const unsigned int field)
virtual void	writeField (const int value, const unsigned int field)
virtual void	writeField (const unsigned int value, const unsigned int field)
Private Member Functions
	LtbFoot ()
	Suppress default.
	LtbFoot (LtbFoot &rhs)
	Suppress default.
LtbFoot &	operator= (LtbFoot &rhs)
	Suppress default.
void	setDataLength (const unsigned int dataLength)
	Sets the data transfer length, in bytes, contained in this readout.
Friends
class	LtbReadout

---

Detailed Description

Definition at line 22 of file LtbFoot.h.

---

Constructor & Destructor Documentation

LtbFoot::~LtbFoot

(

)

[virtual]

Destroy this instance of the class.

Definition at line 37 of file LtbFoot.cc.

                  {
}

LtbFoot::LtbFoot

(

const LtbHead &

head

)

[protected]

Create an instance of this class.

Definition at line 22 of file LtbFoot.cc.

                                    :
LtbBuffer(new char[head.ltbTraits().footSize() * kBytesInInt],
head.ltbTraits()) {
    const LtbTraits& traits = ltbTraits();
    traits.initializeFoot(buffer());
    setDataLength((traits.headSize() + traits.footSize()) * kBytesInInt);
}

LtbFoot::LtbFoot	(	const ByteBuffer &	byteBuffer,
		const LtbTraits &	traits
	)			[protected]

Create an instance of this class.

Definition at line 30 of file LtbFoot.cc.

                                          :
LtbBuffer(byteBuffer,
          traits) {
        byteBuffer.position(byteBuffer.position() + kBytesInInt);
}

DybDaq::LtbFoot::LtbFoot

(

)

[private]

Suppress default.

DybDaq::LtbFoot::LtbFoot

(

LtbFoot &

rhs

)

[private]

Suppress default.

---

Member Function Documentation

unsigned int LtbFoot::dataLength

(

)

const

Returns the data transfer length, in bytes, contained in this readout.

Definition at line 48 of file LtbFoot.cc.

                                       {
        return readUnsignedInt(LtbTraits::kFootDataLength);
}

unsigned int LtbFoot::bufferSize

(

)

const [virtual]

Returns the size, in 4-bytes, of this ojbect's contents in the buffer.

Implements DybDaq::DaqBuffer.

Definition at line 44 of file LtbFoot.cc.

                                       {
    return ltbTraits().footSize();
}

unsigned int LtbFoot::formatComponent

(

)

const [protected, virtual]

Returns the component with the format of this buffer.

Reimplemented from DybDaq::DaqBuffer.

Definition at line 40 of file LtbFoot.cc.

                                            {
    return LtbTraits::kFoot;
}

LtbFoot& DybDaq::LtbFoot::operator=

(

LtbFoot &

rhs

)

[private]

Suppress default.

void LtbFoot::setDataLength

(

const unsigned int

dataLength

)

[private]

Sets the data transfer length, in bytes, contained in this readout.

Definition at line 52 of file LtbFoot.cc.

                                                         {
    writeField(dataLength,
               LtbTraits::kFootDataLength);
}

const LtbTraits & LtbBuffer::ltbTraits

(

)

const [inherited]

Returns the LtbTraits instance used to parse this object's buffer.

Definition at line 36 of file LtbBuffer.cc.

                                            {
        return dynamic_cast<const LtbTraits&>(daqTraits());
}

---

Friends And Related Function Documentation

friend class LtbReadout [friend]

Definition at line 26 of file LtbFoot.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DaqFormat/LtbReadoutFormat/LtbReadoutFormat/LtbFoot.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DaqFormat/LtbReadoutFormat/src/LtbFoot.cc

---