In This Package:

DybDaq::BitsDefinition Class Reference

#include <BitsDefinition.h>

List of all members.

Public Member Functions
	BitsDefinition (const BitsDefinition &rhs)
	Suppress default.
BitsDefinition &	operator= (const BitsDefinition &rhs)
	Suppress default.
	BitsDefinition (unsigned int field, unsigned int offset, unsigned int lowbit, unsigned int count, const std::string &description)
	Creates an instance of this class.
virtual	~BitsDefinition ()
	Destroy this instance of the class.
unsigned int	field () const
	Returns the 'field' index of the value within its containing byte block.
unsigned int	offset () const
	Returns the offset of the value within its containing byte block.
unsigned int	lowBit () const
	The least significant bit containing this value.
unsigned int	highBit () const
	The most significant bit containing this value.
const std::string &	description () const
	The description of the value contained in these bits.
Private Member Functions
	BitsDefinition ()
	Suppress default.
Private Attributes
unsigned int	m_field
	The 'field' index of the value within its containing byte block.
unsigned int	m_offset
	The offset of the value within its containing byte block.
unsigned int	m_lowBit
	The bit that contains the least significant bit of the value.
unsigned int	m_count
	The number of bits containing this value.
const std::string *	m_description
	The description of the value contained in these bits.

---

Detailed Description

Definition at line 16 of file BitsDefinition.h.

---

Constructor & Destructor Documentation

BitsDefinition::BitsDefinition

(

const BitsDefinition &

rhs

)

Suppress default.

Definition at line 33 of file BitsDefinition.cc.

                                                        :
m_field(rhs.m_field),
m_offset(rhs.m_offset),
m_lowBit(rhs.m_lowBit),
m_count(rhs.m_count),
m_description(rhs.m_description) {
}

DybDaq::BitsDefinition::BitsDefinition	(	unsigned int	field,
		unsigned int	offset,
		unsigned int	lowbit,
		unsigned int	count,
		const std::string &	description
	)

Creates an instance of this class.

BitsDefinition::~BitsDefinition

(

)

[virtual]

Destroy this instance of the class.

Definition at line 30 of file BitsDefinition.cc.

                                {
}

BitsDefinition::BitsDefinition

(

)

[private]

Suppress default.

Definition at line 14 of file BitsDefinition.cc.

                               :
m_description(0) {
}

---

Member Function Documentation

BitsDefinition & BitsDefinition::operator=

(

const BitsDefinition &

rhs

)

Suppress default.

Definition at line 41 of file BitsDefinition.cc.

                                                                   {
    m_field = rhs.m_field;
    m_offset = rhs.m_offset;
    m_lowBit = rhs.m_lowBit;
    m_count = rhs.m_count;
    m_description = rhs.m_description;
    return *this;
}

unsigned int BitsDefinition::field

(

)

const

Returns the 'field' index of the value within its containing byte block.

Definition at line 50 of file BitsDefinition.cc.

                                         {
    return m_field;
}

unsigned int BitsDefinition::offset

(

)

const

Returns the offset of the value within its containing byte block.

Definition at line 54 of file BitsDefinition.cc.

                                          {
    return m_offset;
}

unsigned int BitsDefinition::lowBit

(

)

const

The least significant bit containing this value.

Definition at line 58 of file BitsDefinition.cc.

                                          {
    return m_lowBit;
}

unsigned int BitsDefinition::highBit

(

)

const

The most significant bit containing this value.

Definition at line 62 of file BitsDefinition.cc.

                                           {
    if (0 == m_count) {
        return m_lowBit;
    }
    return m_lowBit + m_count - 1;
}

const string & BitsDefinition::description

(

)

const

The description of the value contained in these bits.

Definition at line 69 of file BitsDefinition.cc.

                                                {
    return *m_description;
}

---

Member Data Documentation

unsigned int DybDaq::BitsDefinition::m_field [private]

The 'field' index of the value within its containing byte block.

Definition at line 81 of file BitsDefinition.h.

unsigned int DybDaq::BitsDefinition::m_offset [private]

The offset of the value within its containing byte block.

Definition at line 86 of file BitsDefinition.h.

unsigned int DybDaq::BitsDefinition::m_lowBit [private]

The bit that contains the least significant bit of the value.

Definition at line 91 of file BitsDefinition.h.

unsigned int DybDaq::BitsDefinition::m_count [private]

The number of bits containing this value.

Definition at line 96 of file BitsDefinition.h.

const std::string* DybDaq::BitsDefinition::m_description [private]

The description of the value contained in these bits.

Definition at line 101 of file BitsDefinition.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DaqFormat/DaqReadoutFormat/DaqReadoutFormat/BitsDefinition.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DaqFormat/DaqReadoutFormat/src/BitsDefinition.cc

---