TotemFramePosition Class Reference

#include <TotemFramePosition.h>

Public Member Functions
unsigned short	getFEDId () const
	recomended getters and setters More...
unsigned short	getGOHId () const
unsigned short	getIdxInFiber () const
unsigned short	getOptoRxId () const
unsigned int	getRawPosition () const
	don't use this method unless you have a good reason More...
unsigned short	getSubSystemId () const
	the getters and setters below are deprecated More...
unsigned short	getTOTFEDId () const
bool	operator< (const TotemFramePosition &pos) const
bool	operator== (const TotemFramePosition &pos) const
void	printXML ()
	prints XML formatted DAQ channel to stdout More...
void	setFEDId (unsigned short v)
void	setGOHId (unsigned short v)
void	setIdxInFiber (unsigned short v)
void	setOptoRxId (unsigned short v)
void	setSubSystemId (unsigned short v)
void	setTOTFEDId (unsigned short v)
unsigned char	setXMLAttribute (const std::string &attribute, const std::string &value, unsigned char &flag)
	TotemFramePosition (unsigned short SubSystemId, unsigned short TOTFEDId, unsigned short OptoRxId, unsigned short GOHId, unsigned short IdxInFiber)
	the preferred constructor More...
	TotemFramePosition (unsigned int pos=0)
	don't use this constructor unless you have a good reason More...
	~TotemFramePosition ()

Static Public Member Functions
static bool	checkXMLAttributeFlag (unsigned char flag)
	returns true if all attributes have been set More...

Static Public Attributes
static const unsigned int	maskFEDId = 0x3FF
static const unsigned int	maskGOHId = 0xF
static const unsigned int	maskIdxInFiber = 0xF
static const unsigned int	maskOptoRxId = 0x3
static const unsigned int	maskSubSystemId = 0x7
static const unsigned int	maskTOTFEDId = 0x1F
static const unsigned int	offsetFEDId = 8
static const unsigned int	offsetGOHId = 4
static const unsigned int	offsetIdxInFiber = 0
static const unsigned int	offsetOptoRxId = 8
static const unsigned int	offsetSubSystemId = 15
static const unsigned int	offsetTOTFEDId = 10

Protected Attributes
unsigned int	rawPosition

Friends
std::ostream &	operator<< (std::ostream &s, const TotemFramePosition &fp)

Detailed Description

Uniquely identifies the DAQ channel through which a VFAT frame has been received.

The internal representation has the following structure:

* |                   32 bits raw position                    |
* | 12 bits | 2 bits |  10 bits | 4 bits |       4 bits       |
* |  empty  | empty  |  FED ID  | GOH ID | index within fiber |
* 

In the old (TOTEM only) scheme, the FED ID was further split

* |  3 bits   |  5 bits   |  2 bits   |
* | SubSystem | TOTFED ID | OptoRx ID |
* 

IMPORTANT: This splitting is only supported for backward compatibility and should not be used anymore.

Definition at line 32 of file TotemFramePosition.h.

Constructor & Destructor Documentation

TotemFramePosition::TotemFramePosition ( unsigned short  SubSystemId, unsigned short  TOTFEDId, unsigned short  OptoRxId, unsigned short  GOHId, unsigned short  IdxInFiber  )

inline

the preferred constructor

Definition at line 44 of file TotemFramePosition.h.

                                                                                                                                                      :
      rawPosition(IdxInFiber<<offsetIdxInFiber | GOHId<<offsetGOHId | OptoRxId<<offsetOptoRxId | TOTFEDId<<offsetTOTFEDId | SubSystemId<<offsetSubSystemId)
    {
    }

TotemFramePosition::TotemFramePosition ( unsigned int  pos = 0 )

inline

don't use this constructor unless you have a good reason

Definition at line 50 of file TotemFramePosition.h.

                                             : rawPosition(pos)
    {
    }

TotemFramePosition::~TotemFramePosition ( )

inline

Definition at line 54 of file TotemFramePosition.h.

    {
    }

Member Function Documentation

static bool TotemFramePosition::checkXMLAttributeFlag ( unsigned char  flag )

inlinestatic

returns true if all attributes have been set

Definition at line 126 of file TotemFramePosition.h.

    {
      return (flag == 0x1f);
    }

unsigned short TotemFramePosition::getFEDId ( ) const

inline

recomended getters and setters

Definition at line 60 of file TotemFramePosition.h.

References maskFEDId, offsetFEDId, and rawPosition.

Referenced by operator<<().

    {
      return (rawPosition >> offsetFEDId) & maskFEDId;
    }

unsigned short TotemFramePosition::getGOHId ( ) const

inline

Definition at line 68 of file TotemFramePosition.h.

References maskGOHId, offsetGOHId, and rawPosition.

Referenced by operator<<().

{ return (rawPosition >> offsetGOHId) & maskGOHId; }

unsigned short TotemFramePosition::getIdxInFiber ( ) const

inline

Definition at line 73 of file TotemFramePosition.h.

References maskIdxInFiber, offsetIdxInFiber, and rawPosition.

Referenced by operator<<().

{ return (rawPosition >> offsetIdxInFiber) & maskIdxInFiber; }

unsigned short TotemFramePosition::getOptoRxId ( ) const

inline

Definition at line 91 of file TotemFramePosition.h.

References maskOptoRxId, offsetOptoRxId, and rawPosition.

{ return (rawPosition >> offsetOptoRxId) & maskOptoRxId; }

unsigned int TotemFramePosition::getRawPosition ( ) const

inline

don't use this method unless you have a good reason

Definition at line 97 of file TotemFramePosition.h.

References rawPosition.

    {
      return rawPosition;
    }

unsigned short TotemFramePosition::getSubSystemId ( ) const

inline

the getters and setters below are deprecated

Definition at line 81 of file TotemFramePosition.h.

References maskSubSystemId, offsetSubSystemId, and rawPosition.

{ return (rawPosition >> offsetSubSystemId) & maskSubSystemId; }

unsigned short TotemFramePosition::getTOTFEDId ( ) const

inline

Definition at line 86 of file TotemFramePosition.h.

References maskTOTFEDId, offsetTOTFEDId, and rawPosition.

{ return (rawPosition >> offsetTOTFEDId) & maskTOTFEDId;}

bool TotemFramePosition::operator< ( const TotemFramePosition &  pos ) const

inline

Definition at line 102 of file TotemFramePosition.h.

References rawPosition.

    {
      return (rawPosition < pos.rawPosition);
    }

bool TotemFramePosition::operator== ( const TotemFramePosition &  pos ) const

inline

Definition at line 107 of file TotemFramePosition.h.

References rawPosition.

    {
      return (rawPosition == pos.rawPosition);
    }

void TotemFramePosition::printXML

(

)

prints XML formatted DAQ channel to stdout

Definition at line 28 of file TotemFramePosition.cc.

References gather_cfg::cout.

{
  cout << "\" FEDId=\"" << getFEDId()
    << "\" GOHId=\"" << getGOHId()
    << "\" IdxInFiber=\"" << getIdxInFiber()
    << "\"";
}

void TotemFramePosition::setFEDId ( unsigned short  v )

inline

Definition at line 65 of file TotemFramePosition.h.

References maskFEDId, offsetFEDId, and rawPosition.

    { v &= maskFEDId; rawPosition &= 0xFFFFFFFF - (maskFEDId << offsetFEDId); rawPosition |= (v << offsetFEDId); }

void TotemFramePosition::setGOHId ( unsigned short  v )

inline

Definition at line 70 of file TotemFramePosition.h.

References maskGOHId, offsetGOHId, and rawPosition.

    { v &= maskGOHId; rawPosition &= 0xFFFFFFFF - (maskGOHId << offsetGOHId); rawPosition |= (v << offsetGOHId); }

void TotemFramePosition::setIdxInFiber ( unsigned short  v )

inline

Definition at line 75 of file TotemFramePosition.h.

References maskIdxInFiber, offsetIdxInFiber, and rawPosition.

    { v &= maskIdxInFiber; rawPosition &= 0xFFFFFFFF - (maskIdxInFiber << offsetIdxInFiber); rawPosition |= (v << offsetIdxInFiber); }

void TotemFramePosition::setOptoRxId ( unsigned short  v )

inline

Definition at line 93 of file TotemFramePosition.h.

References maskOptoRxId, offsetOptoRxId, and rawPosition.

    { v &= maskOptoRxId; rawPosition &= 0xFFFFFFFF - (maskOptoRxId << offsetOptoRxId); rawPosition |= (v << offsetOptoRxId); }

void TotemFramePosition::setSubSystemId ( unsigned short  v )

inline

Definition at line 83 of file TotemFramePosition.h.

References maskSubSystemId, offsetSubSystemId, and rawPosition.

    { v &= maskSubSystemId; rawPosition &= 0xFFFFFFFF - (maskSubSystemId << offsetSubSystemId); rawPosition |= (v << offsetSubSystemId); }

void TotemFramePosition::setTOTFEDId ( unsigned short  v )

inline

Definition at line 88 of file TotemFramePosition.h.

References maskTOTFEDId, offsetTOTFEDId, and rawPosition.

    { v &= maskTOTFEDId; rawPosition &= 0xFFFFFFFF - (maskTOTFEDId << offsetTOTFEDId); rawPosition |= (v << offsetTOTFEDId); }

unsigned char TotemFramePosition::setXMLAttribute	(	const std::string &	attribute,
		const std::string &	value,
		unsigned char &	flag
	)

Sets attribute with XML name 'attribute' and value 'value'. Also turns on attribute presents bit in the flag parameter returns 0 if the attribute is known, non-zero value else

Definition at line 38 of file TotemFramePosition.cc.

References findQualityFiles::v.

{
  unsigned int v = atoi(value.c_str());

  if (attribute == "FEDId")
  {
    setFEDId(v);
    flag |= 0x1C; // SubSystem + TOTFED + OptoRx
    return 0;
  }

  if (attribute == "SubSystemId")
  {
    setSubSystemId(v);
    flag |= 0x10;
    return 0;
  }

  if (attribute == "TOTFEDId")
  {
    setTOTFEDId(v);
    flag |= 0x8;
    return 0;
  }

  if (attribute == "OptoRxId")
  {
    setOptoRxId(v);
    flag |= 0x4;
    return 0;
  }

  if (attribute == "GOHId")
  {
    setGOHId(v);
    flag |= 0x2;
    return 0;
  }

  if (attribute == "IdxInFiber")
  {
    setIdxInFiber(v);
    flag |= 0x1;
    return 0;
  }

  return 1;
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  s, const TotemFramePosition &  fp  )

friend

Condensed representation of the DAQ channel. prints 5-digit hex number, the digits correspond to SubSystem, TOTFED ID, OptoRx ID, GOH ID, index within fiber in this order

Definition at line 18 of file TotemFramePosition.cc.

{
  return s
    << fp.getFEDId() << ":"
    << fp.getGOHId() << ":"
    << fp.getIdxInFiber();
}

Member Data Documentation

const unsigned int TotemFramePosition::maskFEDId = 0x3FF

static

Definition at line 37 of file TotemFramePosition.h.

Referenced by getFEDId(), and setFEDId().

const unsigned int TotemFramePosition::maskGOHId = 0xF

static

Definition at line 36 of file TotemFramePosition.h.

Referenced by getGOHId(), and setGOHId().

const unsigned int TotemFramePosition::maskIdxInFiber = 0xF

static

Definition at line 35 of file TotemFramePosition.h.

Referenced by getIdxInFiber(), and setIdxInFiber().

const unsigned int TotemFramePosition::maskOptoRxId = 0x3

static

Definition at line 39 of file TotemFramePosition.h.

Referenced by getOptoRxId(), and setOptoRxId().

const unsigned int TotemFramePosition::maskSubSystemId = 0x7

static

Definition at line 41 of file TotemFramePosition.h.

Referenced by getSubSystemId(), and setSubSystemId().

const unsigned int TotemFramePosition::maskTOTFEDId = 0x1F

static

Definition at line 40 of file TotemFramePosition.h.

Referenced by getTOTFEDId(), and setTOTFEDId().

const unsigned int TotemFramePosition::offsetFEDId = 8

static

Definition at line 37 of file TotemFramePosition.h.

Referenced by getFEDId(), and setFEDId().

const unsigned int TotemFramePosition::offsetGOHId = 4

static

Definition at line 36 of file TotemFramePosition.h.

Referenced by getGOHId(), and setGOHId().

const unsigned int TotemFramePosition::offsetIdxInFiber = 0

static

Definition at line 35 of file TotemFramePosition.h.

Referenced by getIdxInFiber(), and setIdxInFiber().

const unsigned int TotemFramePosition::offsetOptoRxId = 8

static

Definition at line 39 of file TotemFramePosition.h.

Referenced by getOptoRxId(), and setOptoRxId().

const unsigned int TotemFramePosition::offsetSubSystemId = 15

static

Definition at line 41 of file TotemFramePosition.h.

Referenced by getSubSystemId(), and setSubSystemId().

const unsigned int TotemFramePosition::offsetTOTFEDId = 10

static

Definition at line 40 of file TotemFramePosition.h.

Referenced by getTOTFEDId(), and setTOTFEDId().

unsigned int TotemFramePosition::rawPosition

protected

Definition at line 132 of file TotemFramePosition.h.

Referenced by getFEDId(), getGOHId(), getIdxInFiber(), getOptoRxId(), getRawPosition(), getSubSystemId(), getTOTFEDId(), operator<(), operator==(), setFEDId(), setGOHId(), setIdxInFiber(), setOptoRxId(), setSubSystemId(), and setTOTFEDId().