In This Package:

DybDaq::FadcTraits_v1_5

DybDaq::FadcTraits_v1_5 Class Reference

#include <FadcTraits_v1_5.h>

Inheritance diagram for DybDaq::FadcTraits_v1_5:

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


Public Types
typedef std::vector< BitsDefinition >	Definitions
Public Member Functions
	FadcTraits_v1_5 ()
	Creates an instance of this class.
virtual	~FadcTraits_v1_5 ()
	Destroy this instance of the class.
virtual unsigned int	majorVersion () const
virtual unsigned int	minorVersion () const
virtual const std::string	versionString () const
	Returns the version of the event format as a string.
virtual unsigned int	headSize () const
	Returns the size of a FadcHead in this format.
virtual unsigned int	dataSize () const
	Returns the size of a FADC data elementt in this format.
virtual unsigned int	footSize () const
	Returns the size of a FadcFoot in this format.
virtual void	initializeHead (char *buffer) const
	Initializes the FadcHead memory with the appropriate markers.
virtual void	initializeData (char *buffer) const
	Initializes the FadcData memory with the appropriate markers.
virtual void	initializeFoot (char *buffer) const
	Initializes the FadcFoot memory with the appropriate markers.
virtual unsigned int	illegalMarker () const
	Returns the index value for an illegal header.
virtual unsigned int	illegalField () const
	Returns the index value for an illegal field.
virtual const char *	triggerTypeAsString (unsigned int triggerType) const
	Returns the string for the specified trigger type.
virtual unsigned int	marker (unsigned int marker) const
virtual const char *	boolAsString (bool value) const
const DaqTraits::Definitions &	bitsDefinitions (unsigned int component) const
Static Public Member Functions
static const char *	key ()
	Returns a key for this verion, unique with FadcTraits.
static const FadcTraits &	defaultTraits ()
	Returns a default FadcTraits to bootstrap the system.
static const FadcTraits *	readTraits (const char *&buffer)
	Returns the FadcTraits to use given the supplied buffer.
Static Public Attributes
static const unsigned int	kHead = 0
	The head component for this format.
static const unsigned int	kData = FadcTraits::kHead + 1
	The data component for this format.
static const unsigned int	kFoot = FadcTraits::kData + 1
	The foot component for this format.
static const unsigned int	kHeadTriggerNumber = 0
	The field for the trigger number in the head.
static const unsigned int	kMajorVersion = FadcTraits::kHeadTriggerNumber + 1
	The field for the major version.
static const unsigned int	kMinorVersion = FadcTraits::kMajorVersion + 1
	The field for the minor version.
static const unsigned int	kTriggerType = FadcTraits::kMinorVersion + 1
	The field for the trigger type.
static const unsigned int	kNoData = FadcTraits::kTriggerType + 1
	The field for when there is no data.
static const unsigned int	kHeadMarker = FadcTraits::kFootDataLength + 1
	The field for the head marker.
static const unsigned int	kAdcDataMarker = FadcTraits::kHeadMarker + 1
	The field for the ADC data marker.
static const unsigned int	kFootMarker = FadcTraits::kAdcDataMarker + 1
	The field for the foot marker.
static const unsigned int	kProtectionStatus = FadcTraits::kFootMarker + 1
	The field for when there is no data.
static const unsigned int	kScaleEnabled = FadcTraits::kProtectionStatus + 1
	The field for when there is no data.
static const unsigned int	kDuringPrevious = FadcTraits::kScaleEnabled + 1
	The field for when there is no data.
static const unsigned int	kChannelId = FadcTraits::kNoData + 1
	The field for the channel id for the data.
static const unsigned int	kHighDataByte = FadcTraits::kChannelId + 1
	The field for the high data byte.
static const unsigned int	kMiddleDataByte = FadcTraits::kHighDataByte + 1
	The field for the middle data byte.
static const unsigned int	kLowDataByte = FadcTraits::kMiddleDataByte + 1
	The field for the low data byte.
static const unsigned int	kFootTriggerNumber = FadcTraits::kLowDataByte + 1
	The field for the trigger number in the foot.
static const unsigned int	kFootDataLength = FadcTraits::kFootTriggerNumber + 1
	The field for the trigger type.
Protected Member Functions
virtual unsigned int	markersEnd () const
	Returns the maximum number of headers in an event.
virtual const unsigned int *	markers () const
	Returns the markers for the records.
virtual unsigned int	fieldsEnd () const
	Returns the maximum field value for a particluar format.
virtual const unsigned int *	indices () const
	Returns the indices of shifts for fields.
virtual const unsigned int *	shifts () const
	Returns the array of shifts for fields.
virtual const unsigned int *	masks () const
	Returns the array of marks for fields.
virtual const std::string *	descriptions () const
	Returns the array of descriptions for fields.
virtual DaqTraits::Definitions *	definitions (unsigned int component) const
	Returns the array of bits definitions for a compement.
virtual void	setDefinitions (DaqTraits::Definitions *definitions, unsigned int component)
	Sets the array of bits definitions for a compoment.
virtual const unsigned int *	componentFields (unsigned int component) const
	Sets the array of fields for a compoment.
virtual const unsigned int	componentFieldsEnd (unsigned int component) const
	Returns the maximum indexthe array of fields for a compoment.
virtual unsigned int	triggerTypeEnd () const
	Returns the maximum trigger type.
virtual const char **	triggerTypeStrings () const
	Returns the array of trigger type strings.
unsigned int	index (unsigned int field) const
Static Protected Member Functions
static unsigned int	readUnsignedInt (const char *&buffer, const DaqTraits &traits, unsigned int field)
Private Member Functions
	FadcTraits_v1_5 (FadcTraits_v1_5 &rhs)
	Suppress default.
FadcTraits_v1_5 &	operator= (FadcTraits_v1_5 &rhs)
	Suppress default.
Friends
friend class	DaqBuffer

Detailed Description

Definition at line 17 of file FadcTraits_v1_5.h.

Constructor & Destructor Documentation

FadcTraits_v1_5::FadcTraits_v1_5 ( )

Creates an instance of this class.

Definition at line 149 of file FadcTraits_v1_5.cc.

00149                                  {
00150 }

FadcTraits_v1_5::~FadcTraits_v1_5 ( ) [virtual]

Destroy this instance of the class.

Definition at line 152 of file FadcTraits_v1_5.cc.

00152                                   {
00153 }

DybDaq::FadcTraits_v1_5::FadcTraits_v1_5 ( FadcTraits_v1_5 & rhs ) [private]

Suppress default.

Member Function Documentation

const char * FadcTraits_v1_5::key ( ) [static]

Returns a key for this verion, unique with FadcTraits.

Definition at line 145 of file FadcTraits_v1_5.cc.

00145                                  {
00146         return "FADC Format 1.5";
00147 }

unsigned int FadcTraits_v1_5::majorVersion ( ) const [virtual]

Implements DybDaq::DaqTraits.

Definition at line 155 of file FadcTraits_v1_5.cc.

00155                                                  {
00156         return 1U;
00157 }

unsigned int FadcTraits_v1_5::minorVersion ( ) const [virtual]

Implements DybDaq::DaqTraits.

Definition at line 159 of file FadcTraits_v1_5.cc.

00159                                                  {
00160         return 5U;
00161 }

const string FadcTraits_v1_5::versionString ( ) const [virtual]

Returns the version of the event format as a string.

Implements DybDaq::DaqTraits.

Definition at line 163 of file FadcTraits_v1_5.cc.

00163                                                   {
00164         return key();
00165 }

unsigned int FadcTraits_v1_5::headSize ( ) const [virtual]

Returns the size of a FadcHead in this format.

Implements DybDaq::FadcTraits.

Definition at line 167 of file FadcTraits_v1_5.cc.

00167                                              {
00168     return 1U;
00169 }

unsigned int FadcTraits_v1_5::dataSize ( ) const [virtual]

Returns the size of a FADC data elementt in this format.

Implements DybDaq::FadcTraits.

Definition at line 171 of file FadcTraits_v1_5.cc.

00171                                              {
00172     return 1U;
00173 }

unsigned int FadcTraits_v1_5::footSize ( ) const [virtual]

Returns the size of a FadcFoot in this format.

Implements DybDaq::FadcTraits.

Definition at line 175 of file FadcTraits_v1_5.cc.

00175                                              {
00176     return 1U;
00177 }

void FadcTraits_v1_5::initializeHead ( char * buffer ) const [virtual]

Initializes the FadcHead memory with the appropriate markers.

Implements DybDaq::FadcTraits.

Definition at line 179 of file FadcTraits_v1_5.cc.

00179                                                        {
00180     *((unsigned int*)buffer)       = 0x40000000U; // Head four bytes
00181 }

void FadcTraits_v1_5::initializeData ( char * buffer ) const [virtual]

Initializes the FadcData memory with the appropriate markers.

Implements DybDaq::FadcTraits.

Definition at line 183 of file FadcTraits_v1_5.cc.

00183                                                        {
00184     *((unsigned int*)buffer)       = 0x60000000U; // Data four bytes
00185 }

void FadcTraits_v1_5::initializeFoot ( char * buffer ) const [virtual]

Initializes the FadcFoot memory with the appropriate markers.

Implements DybDaq::FadcTraits.

Definition at line 187 of file FadcTraits_v1_5.cc.

00187                                                        {
00188     *((unsigned int*)buffer)       = 0xa0000000U; // Foot four bytes
00189 }

unsigned int FadcTraits_v1_5::markersEnd ( ) const [protected, virtual]

Returns the maximum number of headers in an event.

Implements DybDaq::DaqTraits.

Definition at line 191 of file FadcTraits_v1_5.cc.

00191                                                {
00192     return 0U;
00193 }

const unsigned int * FadcTraits_v1_5::markers ( ) const [protected, virtual]

Returns the markers for the records.

Implements DybDaq::DaqTraits.

Definition at line 195 of file FadcTraits_v1_5.cc.

00195                                                    {
00196     return 0;
00197 }

unsigned int FadcTraits_v1_5::fieldsEnd ( ) const [protected, virtual]

Returns the maximum field value for a particluar format.

Implements DybDaq::DaqTraits.

Definition at line 199 of file FadcTraits_v1_5.cc.

00199                                               {
00200         return kDuringPrevious + 1;
00201 }

const unsigned int * FadcTraits_v1_5::indices ( ) const [protected, virtual]

Returns the indices of shifts for fields.

Implements DybDaq::DaqTraits.

Definition at line 203 of file FadcTraits_v1_5.cc.

00203                                                    {
00204         return m_indices;
00205 }

const unsigned int * FadcTraits_v1_5::shifts ( ) const [protected, virtual]

Returns the array of shifts for fields.

Implements DybDaq::DaqTraits.

Definition at line 207 of file FadcTraits_v1_5.cc.

00207                                                   {
00208         return m_shifts;
00209 }

const unsigned int * FadcTraits_v1_5::masks ( ) const [protected, virtual]

Returns the array of marks for fields.

Implements DybDaq::DaqTraits.

Definition at line 211 of file FadcTraits_v1_5.cc.

00211                                                  {
00212         return m_masks;
00213 }

const std::string * FadcTraits_v1_5::descriptions ( ) const [protected, virtual]

Returns the array of descriptions for fields.

Reimplemented from DybDaq::DaqTraits.

Definition at line 215 of file FadcTraits_v1_5.cc.

00215                                                      {
00216     return m_description;
00217 }

DaqTraits::Definitions * FadcTraits_v1_5::definitions ( unsigned int component ) const [protected, virtual]

Returns the array of bits definitions for a compement.

Reimplemented from DybDaq::DaqTraits.

Definition at line 219 of file FadcTraits_v1_5.cc.

00219                                                                                {
00220     return m_definitions[component];
00221 }

void FadcTraits_v1_5::setDefinitions	(	DaqTraits::Definitions *	definitions,
		unsigned int	component
	)			`[protected, virtual]`

Sets the array of bits definitions for a compoment.

Reimplemented from DybDaq::DaqTraits.

Definition at line 223 of file FadcTraits_v1_5.cc.

00224                                                              {
00225     m_definitions[component] = definitions;
00226 }

const unsigned int * FadcTraits_v1_5::componentFields ( unsigned int component ) const [protected, virtual]

Sets the array of fields for a compoment.

Reimplemented from DybDaq::DaqTraits.

Definition at line 228 of file FadcTraits_v1_5.cc.

00228                                                                                  {
00229     return m_componentFields[component];
00230 }

const unsigned int FadcTraits_v1_5::componentFieldsEnd ( unsigned int component ) const [protected, virtual]

Returns the maximum indexthe array of fields for a compoment.

Reimplemented from DybDaq::DaqTraits.

Definition at line 232 of file FadcTraits_v1_5.cc.

00232                                                                                    {
00233     return m_componentFieldsEnd[component];
00234 }

unsigned int FadcTraits_v1_5::triggerTypeEnd ( ) const [protected, virtual]

Returns the maximum trigger type.

Implements DybDaq::FadcTraits.

Definition at line 236 of file FadcTraits_v1_5.cc.

00236                                                    {
00237     return 2U;
00238 }

const char ** FadcTraits_v1_5::triggerTypeStrings ( ) const [protected, virtual]

Returns the array of trigger type strings.

Implements DybDaq::FadcTraits.

Definition at line 240 of file FadcTraits_v1_5.cc.

00240                                                        {
00241     return m_triggerTypes;
00242 }

FadcTraits_v1_5& DybDaq::FadcTraits_v1_5::operator= ( FadcTraits_v1_5 & rhs ) [private]

Suppress default.

const FadcTraits & FadcTraits::defaultTraits ( ) [static, inherited]

Returns a default FadcTraits to bootstrap the system.

Definition at line 57 of file FadcTraits.cc.

00057                                             {
00058     if (0 == m_allTraits.size()) {
00059         m_allTraits.insert(std::pair<const char*, FadcTraits*>(FadcTraits_v1_2::key(),new FadcTraits_v1_2()));
00060         m_allTraits.insert(std::pair<const char*, FadcTraits*>(FadcTraits_v1_5::key(),new FadcTraits_v1_5()));
00061     }
00062     return *m_allTraits[FadcTraits_v1_5::key()];
00063 }

const FadcTraits * FadcTraits::readTraits ( const char *& buffer ) [static, inherited]

Returns the FadcTraits to use given the supplied buffer.

Definition at line 65 of file FadcTraits.cc.

00065                                                             {
00066     unsigned int major = 0;
00067     const unsigned int minor = readUnsignedInt(buffer,
00068                                              defaultTraits(),
00069                                              FadcTraits::kMinorVersion);
00070     
00071     const FadcTraits* result = 0;
00072     if (0U == major && 0U == minor) {
00073         result = m_allTraits[FadcTraits_v1_2::key()];
00074     } else if (0U == major && 1U == minor) {
00075             result = m_allTraits[FadcTraits_v1_2::key()];
00076     }
00077     return result;
00078 }

unsigned int FadcTraits::illegalMarker ( ) const [virtual, inherited]

Returns the index value for an illegal header.

Implements DybDaq::DaqTraits.

Definition at line 80 of file FadcTraits.cc.

00080                                              {
00081     return 0xffffffffU;
00082 }

unsigned int FadcTraits::illegalField ( ) const [virtual, inherited]

Returns the index value for an illegal field.

Implements DybDaq::DaqTraits.

Definition at line 84 of file FadcTraits.cc.

00084                                             {
00085     return 0xffffffffU;
00086 }

const char * FadcTraits::triggerTypeAsString ( unsigned int triggerType ) const [virtual, inherited]

Returns the string for the specified trigger type.

Definition at line 88 of file FadcTraits.cc.

00088                                                                           {
00089     if (triggerType >= triggerTypeEnd()) {
00090         return "Unknown";
00091     }
00092     return triggerTypeStrings()[triggerType];
00093 }

Member Data Documentation

const unsigned int FadcTraits::kHead = 0 [static, inherited]

The head component for this format.

Definition at line 24 of file FadcTraits.h.

const unsigned int FadcTraits::kData = FadcTraits::kHead + 1 [static, inherited]

The data component for this format.

Definition at line 29 of file FadcTraits.h.

const unsigned int FadcTraits::kFoot = FadcTraits::kData + 1 [static, inherited]

The foot component for this format.

Definition at line 34 of file FadcTraits.h.

const unsigned int FadcTraits::kHeadTriggerNumber = 0 [static, inherited]

The field for the trigger number in the head.

Definition at line 39 of file FadcTraits.h.

const unsigned int FadcTraits::kMajorVersion = FadcTraits::kHeadTriggerNumber + 1 [static, inherited]

The field for the major version.

Definition at line 46 of file FadcTraits.h.

const unsigned int FadcTraits::kMinorVersion = FadcTraits::kMajorVersion + 1 [static, inherited]

The field for the minor version.

Definition at line 51 of file FadcTraits.h.

const unsigned int FadcTraits::kTriggerType = FadcTraits::kMinorVersion + 1 [static, inherited]

The field for the trigger type.

Definition at line 56 of file FadcTraits.h.

const unsigned int FadcTraits::kNoData = FadcTraits::kTriggerType + 1 [static, inherited]

The field for when there is no data.

Definition at line 61 of file FadcTraits.h.

const unsigned int FadcTraits::kHeadMarker = FadcTraits::kFootDataLength + 1 [static, inherited]

The field for the head marker.

Definition at line 68 of file FadcTraits.h.

const unsigned int FadcTraits::kAdcDataMarker = FadcTraits::kHeadMarker + 1 [static, inherited]

The field for the ADC data marker.

Definition at line 73 of file FadcTraits.h.

const unsigned int FadcTraits::kFootMarker = FadcTraits::kAdcDataMarker + 1 [static, inherited]

The field for the foot marker.

Definition at line 78 of file FadcTraits.h.

const unsigned int FadcTraits::kProtectionStatus = FadcTraits::kFootMarker + 1 [static, inherited]

The field for when there is no data.

Definition at line 85 of file FadcTraits.h.

const unsigned int FadcTraits::kScaleEnabled = FadcTraits::kProtectionStatus + 1 [static, inherited]

The field for when there is no data.

Definition at line 90 of file FadcTraits.h.

const unsigned int FadcTraits::kDuringPrevious = FadcTraits::kScaleEnabled + 1 [static, inherited]

The field for when there is no data.

Definition at line 95 of file FadcTraits.h.

const unsigned int FadcTraits::kChannelId = FadcTraits::kNoData + 1 [static, inherited]

The field for the channel id for the data.

Definition at line 102 of file FadcTraits.h.

const unsigned int FadcTraits::kHighDataByte = FadcTraits::kChannelId + 1 [static, inherited]

The field for the high data byte.

Definition at line 107 of file FadcTraits.h.

const unsigned int FadcTraits::kMiddleDataByte = FadcTraits::kHighDataByte + 1 [static, inherited]

The field for the middle data byte.

Definition at line 112 of file FadcTraits.h.

const unsigned int FadcTraits::kLowDataByte = FadcTraits::kMiddleDataByte + 1 [static, inherited]

The field for the low data byte.

Definition at line 117 of file FadcTraits.h.

const unsigned int FadcTraits::kFootTriggerNumber = FadcTraits::kLowDataByte + 1 [static, inherited]

The field for the trigger number in the foot.

Definition at line 124 of file FadcTraits.h.

const unsigned int FadcTraits::kFootDataLength = FadcTraits::kFootTriggerNumber + 1 [static, inherited]

The field for the trigger type.

Definition at line 129 of file FadcTraits.h.

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

/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DaqFormat/FadcReadoutFormat/FadcReadoutFormat/FadcTraits_v1_5.h
/home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/dybgaudi/DaqFormat/FadcReadoutFormat/src/FadcTraits_v1_5.cc

Generated on Mon Apr 11 20:07:57 2011 for FadcReadoutFormat by 1.4.7

In This Package:

DybDaq::FadcTraits_v1_5 Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation