fmssim
Public Member Functions | Protected Attributes
fms::geometry::Cell Class Reference

Abstract base class for a single FMS cell. More...

#include <Cell.h>

List of all members.

Public Member Functions

 Cell (Double_t xmin=0., Double_t xmax=0., Double_t ymin=0., Double_t ymax=0.)
virtual ~Cell ()
virtual Double_t Width () const =0
 The width of the cell in cm.
virtual Double_t Height () const =0
 The height of the cell in cm.
virtual Double_t XMin () const
 The x coordinate of the lower-x edge.
virtual Double_t XMax () const
 The x coordinate of the upper-x edge.
virtual Double_t YMin () const
 The y coordinate of the bottom edge.
virtual Double_t YMax () const
 The y coordinate of the top edge.
virtual Bool_t Contains (const TVector3 &) const
 Returns true if the position vector lies in the cell face.
virtual void Mask (Bool_t=true)
 Set this cell's "masked" flag indicating that it is ignored or inactive.
virtual Bool_t IsMasked () const
 Returns the cell's "masked" flag.
virtual Int_t GetQtBoard () const
 Returns the number of the QT board to which this cell is connected.
virtual void SetQtBoard (Int_t)
 Set the QT board to which this cell belongs.
virtual UInt_t Channel () const
 Returns the channel number of the cell.
virtual void SetChannel (UInt_t)
 Sets the channel number of the cell.

Protected Attributes

Bool_t mMasked
UInt_t mChannel
Int_t mColumn
Int_t mRow
Int_t mQtBoard
Double_t mXMin
Double_t mXMax
Double_t mYMin
Double_t mYMax

Detailed Description

Abstract base class for a single FMS cell.

The cell is rectangular in cross section with its face in the xy plane.

Todo:
Make this a more general base class. Remove x/y/z coordinates. Implement those in a CellXYZ class, and inherit smallcell and largecell from those.

Constructor & Destructor Documentation

fms::geometry::Cell::Cell ( Double_t  xmin = 0.,
Double_t  xmax = 0.,
Double_t  ymin = 0.,
Double_t  ymax = 0. 
)
fms::geometry::Cell::~Cell ( ) [virtual]

Member Function Documentation

UInt_t fms::geometry::Cell::Channel ( ) const [inline, virtual]

Returns the channel number of the cell.

This is a unique identifier for the cell in the detector to which it belongs.

Reimplemented in fms::geometry::LargeCell, and fms::geometry::SmallCell.

Bool_t fms::geometry::Cell::Contains ( const TVector3 &  v) const [virtual]

Returns true if the position vector lies in the cell face.

The z coordinate is not considered.

Todo:
TVector2 instead?
Int_t fms::geometry::Cell::GetQtBoard ( ) const [inline, virtual]

Returns the number of the QT board to which this cell is connected.

Returns a value < 0 if the QT board is unkown.

Reimplemented in fms::geometry::SmallCell.

virtual Double_t fms::geometry::Cell::Height ( ) const [pure virtual]

The height of the cell in cm.

Implemented in fms::geometry::LargeCell, and fms::geometry::SmallCell.

Bool_t fms::geometry::Cell::IsMasked ( ) const [inline, virtual]

Returns the cell's "masked" flag.

void fms::geometry::Cell::Mask ( Bool_t  b = true) [inline, virtual]

Set this cell's "masked" flag indicating that it is ignored or inactive.

void fms::geometry::Cell::SetChannel ( UInt_t  c) [inline, virtual]

Sets the channel number of the cell.

This should be a unique identifier for the cell in the detector to which it belongs.

Reimplemented in fms::geometry::LargeCell, and fms::geometry::SmallCell.

void fms::geometry::Cell::SetQtBoard ( Int_t  i) [inline, virtual]

Set the QT board to which this cell belongs.

Use a value < 0 to indicate that the QT board is unknown.

Reimplemented in fms::geometry::SmallCell.

virtual Double_t fms::geometry::Cell::Width ( ) const [pure virtual]

The width of the cell in cm.

Implemented in fms::geometry::LargeCell, and fms::geometry::SmallCell.

Double_t fms::geometry::Cell::XMax ( ) const [inline, virtual]

The x coordinate of the upper-x edge.

Double_t fms::geometry::Cell::XMin ( ) const [inline, virtual]

The x coordinate of the lower-x edge.

Double_t fms::geometry::Cell::YMax ( ) const [inline, virtual]

The y coordinate of the top edge.

Double_t fms::geometry::Cell::YMin ( ) const [inline, virtual]

The y coordinate of the bottom edge.


Member Data Documentation

UInt_t fms::geometry::Cell::mChannel [protected]
Int_t fms::geometry::Cell::mColumn [protected]
Bool_t fms::geometry::Cell::mMasked [protected]
Int_t fms::geometry::Cell::mQtBoard [protected]
Int_t fms::geometry::Cell::mRow [protected]
Double_t fms::geometry::Cell::mXMax [protected]
Double_t fms::geometry::Cell::mXMin [protected]
Double_t fms::geometry::Cell::mYMax [protected]
Double_t fms::geometry::Cell::mYMin [protected]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines