SctData::ModuleElement Class Reference

Represents an contiguous element of a module : may be a chip, link or channel. More...

#include <ModuleElement.h>

Public Member Functions
	ModuleElement (const unsigned first, const unsigned last)
	Constructor takes the first and last channel of the element.
	~ModuleElement () throw ()
	Destructor.
unsigned	getFirst () const throw ()
	First channel contained (0->1535).
unsigned	getLast () const throw ()
	Last channel contained (0->1535).
unsigned	getNChannels () const throw ()
	the number of channels (=last-first+1)
bool	isChannel () const throw ()
	true if only contains one element
bool	isChip () const throw ()
	true if the channels contained precisely match one chip
bool	isLink () const throw ()
	true if the channels contained precisely match one link
bool	isModule () const throw ()
	true if all of the channels are contained
bool	operator== (const ModuleElement &) const throw ()
	explicit equality operator true if first and last are equal
bool	isWithin (const ModuleElement &) const throw ()
	true if this element is contained within or equal to the argument
bool	contains (const ModuleElement &) const throw ()
	true if this element contains or is equal to the RHS element
bool	overlaps (const ModuleElement &) const throw ()
	true if this element overlaps any part of RHS element
bool	adjacentTo (const ModuleElement &) const throw ()
Static Public Member Functions
Named Constructors:
ModuleElement	Module () throw ()
	Returns a ModuleElement representing a whole Module.
ModuleElement	Link (unsigned int link)
	Returns a ModuleElement representing Link link.
ModuleElement	Chip (unsigned int chip)
	Returns a ModuleElement representing Chip chip.
ModuleElement	Channel (unsigned int channel)
	Returns a ModuleElement representing Channel channel.
Private Member Functions
	ModuleElement () throw ()
	can't do this
Private Attributes
unsigned	first
unsigned	last

---

Detailed Description

Represents an contiguous element of a module : may be a chip, link or channel.

Author:

Alan Barr

Date:

3 July 2003

Definition at line 15 of file ModuleElement.h.

---

Constructor & Destructor Documentation

SctData::ModuleElement::ModuleElement (  const unsigned  first, const unsigned  last )  [inline]

Constructor takes the first and last channel of the element. 0,127 for chip 0 link 0, or perhaps 768, 895 for chip 0 link 1. Parameters: first  channel contained last  channel contained Exceptions: OutOfRangeError  if last<first or last>1535. Definition at line 85 of file ModuleElement.h.

SctData::ModuleElement::~ModuleElement (   )  throw () [inline]

Destructor. Definition at line 50 of file ModuleElement.h.

SctData::ModuleElement::ModuleElement (   )  throw () [private]

can't do this

---

Member Function Documentation

bool SctData::ModuleElement::adjacentTo (  const ModuleElement &   )  const throw () [inline]

Returns: true if this element is logically next to RHS element Note: includes `adjacent' across chip and even link boundries. overlapping elements are not adjacent. Definition at line 130 of file ModuleElement.h. Referenced by SctData::DefectList::addDefect().

ModuleElement SctData::ModuleElement::Channel (  unsigned int  channel  )  [static]

Returns a ModuleElement representing Channel channel. Exceptions: OutOfRangeError  if channel>nChannelModule

ModuleElement SctData::ModuleElement::Chip (  unsigned int  chip  )  [static]

Returns a ModuleElement representing Chip chip. Exceptions: OutOfRangeError  if chip>=nChipModule

bool SctData::ModuleElement::contains (  const ModuleElement &   )  const throw () [inline]

true if this element contains or is equal to the RHS element Definition at line 121 of file ModuleElement.h. Referenced by SctData::DefectList::addDefect().

unsigned SctData::ModuleElement::getFirst (   )  const throw () [inline]

First channel contained (0->1535). Definition at line 52 of file ModuleElement.h. Referenced by SctData::DefectList::addDefect(), SctCalibrationController::ConfigUpdater::maskChannels(), SctData::TestSummary::SummaryWriter::write(), and SctData::IO::DefectListStreamer_v1::write().

unsigned SctData::ModuleElement::getLast (   )  const throw () [inline]

Last channel contained (0->1535). Definition at line 54 of file ModuleElement.h. Referenced by SctData::DefectList::addDefect(), SctCalibrationController::ConfigUpdater::maskChannels(), and SctData::TestSummary::SummaryWriter::write().

unsigned int SctData::ModuleElement::getNChannels (   )  const throw () [inline]

the number of channels (=last-first+1) Definition at line 98 of file ModuleElement.h. Referenced by SctData::TestSummary::SummaryWriter::write(), and SctData::IO::DefectListStreamer_v1::write().

bool SctData::ModuleElement::isChannel (   )  const throw () [inline]

true if only contains one element Definition at line 101 of file ModuleElement.h.

bool SctData::ModuleElement::isChip (   )  const throw () [inline]

true if the channels contained precisely match one chip Definition at line 104 of file ModuleElement.h.

bool SctData::ModuleElement::isLink (   )  const throw () [inline]

true if the channels contained precisely match one link Definition at line 107 of file ModuleElement.h.

bool SctData::ModuleElement::isModule (   )  const throw () [inline]

true if all of the channels are contained Definition at line 110 of file ModuleElement.h.

bool SctData::ModuleElement::isWithin (  const ModuleElement &   )  const throw () [inline]

true if this element is contained within or equal to the argument Definition at line 118 of file ModuleElement.h.

ModuleElement SctData::ModuleElement::Link (  unsigned int  link  )  [static]

Returns a ModuleElement representing Link link. Exceptions: OutOfRangeError  if link>=nLinkModule

ModuleElement SctData::ModuleElement::Module (   )  throw () [inline, static]

Returns a ModuleElement representing a whole Module. Definition at line 147 of file ModuleElement.h.

bool SctData::ModuleElement::operator== (  const ModuleElement &   )  const throw () [inline]

explicit equality operator true if first and last are equal Definition at line 114 of file ModuleElement.h.

bool SctData::ModuleElement::overlaps (  const ModuleElement &   )  const throw () [inline]

true if this element overlaps any part of RHS element Definition at line 125 of file ModuleElement.h. Referenced by SctData::DefectList::addDefect().

---

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

• ModuleElement.h

---