In This Package:

DybDaq::FeeFoot Class Reference

#include <FeeFoot.h>

Inheritance diagram for DybDaq::FeeFoot:

[legend]Collaboration diagram for DybDaq::FeeFoot:[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	~FeeFoot ()
	Destroy this instance of the class.
unsigned int	triggerNumber () const
	Returns the module address from this readout.
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 FeeTraits &	feeTraits () const
	Returns the FeeTraits 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
	FeeFoot (const FeeHead &head)
	Create an instance of this class.
	FeeFoot (const ByteBuffer &byteBuffer, const FeeTraits &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
	FeeFoot ()
	Suppress default.
	FeeFoot (FeeFoot &rhs)
	Suppress default.
FeeFoot &	operator= (FeeFoot &rhs)
	Suppress default.
void	setTriggerNumber (const unsigned int triggerNumber)
	Sets the trigger number for this readout.
void	setDataLength (const unsigned int dataLength)
	Sets the data transfer length, in bytes, contained in this readout.
Friends
class	FeeReadout

---

Detailed Description

Definition at line 22 of file FeeFoot.h.

---

Constructor & Destructor Documentation

FeeFoot::~FeeFoot

(

)

[virtual]

Destroy this instance of the class.

Definition at line 36 of file FeeFoot.cc.

                  {
}

FeeFoot::FeeFoot

(

const FeeHead &

head

)

[protected]

Create an instance of this class.

Definition at line 20 of file FeeFoot.cc.

                                    :
FeeBuffer(new char[head.feeTraits().footSize() * kBytesInInt],
          head.feeTraits()) {
    const FeeTraits& traits = feeTraits();
    traits.initializeFoot(buffer());
    setTriggerNumber(head.triggerNumber());
    setDataLength((traits.headSize() + traits.footSize()) * kBytesInInt);
}

FeeFoot::FeeFoot	(	const ByteBuffer &	byteBuffer,
		const FeeTraits &	traits
	)			[protected]

Create an instance of this class.

Definition at line 29 of file FeeFoot.cc.

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

DybDaq::FeeFoot::FeeFoot

(

)

[private]

Suppress default.

DybDaq::FeeFoot::FeeFoot

(

FeeFoot &

rhs

)

[private]

Suppress default.

---

Member Function Documentation

unsigned int FeeFoot::triggerNumber

(

)

const

Returns the module address from this readout.

Definition at line 43 of file FeeFoot.cc.

                                          {
        return readUnsignedInt(FeeTraits::kFootTriggerNumber);
}

unsigned int FeeFoot::dataLength

(

)

const

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

Definition at line 47 of file FeeFoot.cc.

                                       {
        return readUnsignedInt(FeeTraits::kFootDataLength);
}

unsigned int FeeFoot::bufferSize

(

)

const [virtual]

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

Implements DybDaq::DaqBuffer.

Definition at line 51 of file FeeFoot.cc.

                                       {
    return feeTraits().footSize();
}

unsigned int FeeFoot::formatComponent

(

)

const [protected, virtual]

Returns the component with the format of this buffer.

Reimplemented from DybDaq::DaqBuffer.

Definition at line 39 of file FeeFoot.cc.

                                            {
    return FeeTraits::kFoot;
}

FeeFoot& DybDaq::FeeFoot::operator=

(

FeeFoot &

rhs

)

[private]

Suppress default.

void FeeFoot::setTriggerNumber

(

const unsigned int

triggerNumber

)

[private]

Sets the trigger number for this readout.

Definition at line 55 of file FeeFoot.cc.

                                                               {
    writeField(triggerNumber,
               FeeTraits::kFootTriggerNumber);
}

void FeeFoot::setDataLength

(

const unsigned int

dataLength

)

[private]

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

Definition at line 60 of file FeeFoot.cc.

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

const FeeTraits & FeeBuffer::feeTraits

(

)

const [inherited]

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

Definition at line 34 of file FeeBuffer.cc.

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

---

Friends And Related Function Documentation

friend class FeeReadout [friend]

Definition at line 26 of file FeeFoot.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DaqFormat/FeeReadoutFormat/FeeReadoutFormat/FeeFoot.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DaqFormat/FeeReadoutFormat/src/FeeFoot.cc

---