AlignableDetOrUnitPtr Class Reference

#include <AlignableDetOrUnitPtr.h>

Public Member Functions
Alignable *	alignable ()
const Alignable *	alignable () const
AlignableBeamSpot *	alignableBeamSpot ()
const AlignableBeamSpot *	alignableBeamSpot () const
AlignableDet *	alignableDet ()
const AlignableDet *	alignableDet () const
	AlignableDetOrUnitPtr (AlignableBeamSpot *aliBeamSpot)
	Constructor from AlignableBeamSpot* (non-explicit: for automatic conversions) More...
	AlignableDetOrUnitPtr (AlignableDet *aliDet)
	Constructor from AlignableDet* (non-explicit: for automatic conversions) More...
	AlignableDetOrUnitPtr (AlignableDetUnit *aliDetUnit)
	Constructor from AlignableDetUnit* (non-explicit: for automatic conversions) More...
AlignableDetUnit *	alignableDetUnit ()
const AlignableDetUnit *	alignableDetUnit () const
const AlignmentPositionError *	alignmentPositionError () const
	alignment position error (see comments in specific classes) More...
bool	isNull () const
	check for empty pointer More...
	operator Alignable * ()
	operator const Alignable * () const
Alignable *	operator-> ()
const Alignable *	operator-> () const
AlignableDetOrUnitPtr &	operator= (AlignableBeamSpot *aliBeamSpot)
AlignableDetOrUnitPtr &	operator= (AlignableDet *aliDet)
AlignableDetOrUnitPtr &	operator= (AlignableDetUnit *aliDetUnit)
	~AlignableDetOrUnitPtr ()
	Non-virtual destructor: do not use as base class. More...

Private Attributes
AlignableBeamSpot *	theAliBeamSpot
	Pointer to Alignable if it is the beam spot. More...
AlignableDet *	theAliDet
	Pointer to Alignable if it is a Det. More...
AlignableDetUnit *	theAliDetUnit
	Pointer to Alignable if it is a DetUnit. More...

Detailed Description

Class to hold either a pointer to an AlignableDet or to an AlignableDetUnit. As such it is like a pointer to an Alignable of that hierarchy level on which hits can exists. Therefore it should be used whenever it should be ensured by C++ type safety that a lowest level Alignable* is dealt with.

Conversion and '->' operators exist to use this class as a pointer to the base class Alignable. On the other hand, the accessors alignableDet() and alignableDetUnit() can be used to check which concrete type it is.

Since this class is very light weighted, it can be used by value.

Original author: Gero Flucke, April 2007

Date

2009/02/28 21:04:59

Revision

1.3

(last update by

Author

flucke

)

Definition at line 30 of file AlignableDetOrUnitPtr.h.

Constructor & Destructor Documentation

AlignableDetOrUnitPtr() [1/3]

AlignableDetOrUnitPtr::AlignableDetOrUnitPtr ( AlignableBeamSpot *  aliBeamSpot )

inline

Constructor from AlignableBeamSpot* (non-explicit: for automatic conversions)

Definition at line 33 of file AlignableDetOrUnitPtr.h.

      : theAliBeamSpot(aliBeamSpot), theAliDet(nullptr), theAliDetUnit(nullptr) {}

AlignableDetOrUnitPtr() [2/3]

AlignableDetOrUnitPtr::AlignableDetOrUnitPtr ( AlignableDet *  aliDet )

inline

Constructor from AlignableDet* (non-explicit: for automatic conversions)

Definition at line 37 of file AlignableDetOrUnitPtr.h.

      : theAliBeamSpot(nullptr), theAliDet(aliDet), theAliDetUnit(nullptr) {}

AlignableDetOrUnitPtr() [3/3]

AlignableDetOrUnitPtr::AlignableDetOrUnitPtr ( AlignableDetUnit *  aliDetUnit )

inline

Constructor from AlignableDetUnit* (non-explicit: for automatic conversions)

Definition at line 41 of file AlignableDetOrUnitPtr.h.

      : theAliBeamSpot(nullptr), theAliDet(nullptr), theAliDetUnit(aliDetUnit) {}

~AlignableDetOrUnitPtr()

AlignableDetOrUnitPtr::~AlignableDetOrUnitPtr ( )

inline

Non-virtual destructor: do not use as base class.

Definition at line 44 of file AlignableDetOrUnitPtr.h.

{}

Member Function Documentation

alignable() [1/2]

Alignable* AlignableDetOrUnitPtr::alignable ( )

inline

Definition at line 72 of file AlignableDetOrUnitPtr.h.

{ return this->operator Alignable*(); }

Referenced by CSCAlignmentCorrections::applyAlignment(), and CSCChamberFitter::radiusCorrection().

alignable() [2/2]

const Alignable* AlignableDetOrUnitPtr::alignable ( ) const

inline

Definition at line 73 of file AlignableDetOrUnitPtr.h.

{ return this->operator const Alignable*(); }

alignableBeamSpot() [1/2]

AlignableBeamSpot* AlignableDetOrUnitPtr::alignableBeamSpot ( )

inline

Definition at line 76 of file AlignableDetOrUnitPtr.h.

{ return theAliBeamSpot; }

References theAliBeamSpot.

alignableBeamSpot() [2/2]

const AlignableBeamSpot* AlignableDetOrUnitPtr::alignableBeamSpot ( ) const

inline

Definition at line 77 of file AlignableDetOrUnitPtr.h.

{ return theAliBeamSpot; }

References theAliBeamSpot.

alignableDet() [1/2]

AlignableDet* AlignableDetOrUnitPtr::alignableDet ( )

inline

Definition at line 78 of file AlignableDetOrUnitPtr.h.

{ return theAliDet; }

References theAliDet.

alignableDet() [2/2]

const AlignableDet* AlignableDetOrUnitPtr::alignableDet ( ) const

inline

Definition at line 79 of file AlignableDetOrUnitPtr.h.

{ return theAliDet; }

References theAliDet.

alignableDetUnit() [1/2]

AlignableDetUnit* AlignableDetOrUnitPtr::alignableDetUnit ( )

inline

Definition at line 80 of file AlignableDetOrUnitPtr.h.

{ return theAliDetUnit; }

References theAliDetUnit.

alignableDetUnit() [2/2]

const AlignableDetUnit* AlignableDetOrUnitPtr::alignableDetUnit ( ) const

inline

Definition at line 81 of file AlignableDetOrUnitPtr.h.

{ return theAliDetUnit; }

References theAliDetUnit.

alignmentPositionError()

const AlignmentPositionError * AlignableDetOrUnitPtr::alignmentPositionError

(

)

const

alignment position error (see comments in specific classes)

Definition at line 40 of file AlignableDetOrUnitPtr.cc.

                                                                                  {
  if (theAliBeamSpot)
    return theAliBeamSpot->alignmentPositionError();
  else if (theAliDet)
    return theAliDet->alignmentPositionError();
  else if (theAliDetUnit)
    return theAliDetUnit->alignmentPositionError();
  else
    return nullptr;
}

References AlignableDet::alignmentPositionError(), AlignableBeamSpot::alignmentPositionError(), AlignableDetUnit::alignmentPositionError(), theAliBeamSpot, theAliDet, and theAliDetUnit.

isNull()

bool AlignableDetOrUnitPtr::isNull ( ) const

inline

check for empty pointer

Definition at line 84 of file AlignableDetOrUnitPtr.h.

{ return (!theAliBeamSpot && !theAliDet && !theAliDetUnit); }

References theAliBeamSpot, theAliDet, and theAliDetUnit.

operator Alignable *()

AlignableDetOrUnitPtr::operator Alignable *

(

)

Definition at line 20 of file AlignableDetOrUnitPtr.cc.

                                           {
  if (theAliBeamSpot)
    return theAliBeamSpot;
  else if (theAliDet)
    return theAliDet;
  else
    return theAliDetUnit;
}

operator const Alignable *()

AlignableDetOrUnitPtr::operator const Alignable *

(

)

const

Definition at line 30 of file AlignableDetOrUnitPtr.cc.

                                                       {
  if (theAliBeamSpot)
    return theAliBeamSpot;
  else if (theAliDet)
    return theAliDet;
  else
    return theAliDetUnit;
}

operator->() [1/2]

Alignable* AlignableDetOrUnitPtr::operator-> ( )

inline

Definition at line 69 of file AlignableDetOrUnitPtr.h.

{ return this->operator Alignable*(); }

operator->() [2/2]

const Alignable* AlignableDetOrUnitPtr::operator-> ( ) const

inline

Definition at line 70 of file AlignableDetOrUnitPtr.h.

{ return this->operator const Alignable*(); }

operator=() [1/3]

AlignableDetOrUnitPtr& AlignableDetOrUnitPtr::operator= ( AlignableBeamSpot *  aliBeamSpot )

inline

Definition at line 46 of file AlignableDetOrUnitPtr.h.

                                                                          {
    theAliBeamSpot = aliBeamSpot;
    theAliDet = nullptr;
    theAliDetUnit = nullptr;
    return *this;
  }

References theAliBeamSpot, theAliDet, and theAliDetUnit.

operator=() [2/3]

AlignableDetOrUnitPtr& AlignableDetOrUnitPtr::operator= ( AlignableDet *  aliDet )

inline

Definition at line 52 of file AlignableDetOrUnitPtr.h.

                                                                {
    theAliBeamSpot = nullptr;
    theAliDet = aliDet;
    theAliDetUnit = nullptr;
    return *this;
  }

References theAliBeamSpot, theAliDet, and theAliDetUnit.

operator=() [3/3]

AlignableDetOrUnitPtr& AlignableDetOrUnitPtr::operator= ( AlignableDetUnit *  aliDetUnit )

inline

Definition at line 58 of file AlignableDetOrUnitPtr.h.

                                                                        {
    theAliBeamSpot = nullptr;
    theAliDet = nullptr;
    theAliDetUnit = aliDetUnit;
    return *this;
  }

References theAliBeamSpot, theAliDet, and theAliDetUnit.

Member Data Documentation

theAliBeamSpot

AlignableBeamSpot* AlignableDetOrUnitPtr::theAliBeamSpot

private

Pointer to Alignable if it is the beam spot.

Definition at line 92 of file AlignableDetOrUnitPtr.h.

Referenced by alignableBeamSpot(), alignmentPositionError(), isNull(), and operator=().

theAliDet

AlignableDet* AlignableDetOrUnitPtr::theAliDet

private

Pointer to Alignable if it is a Det.

Definition at line 93 of file AlignableDetOrUnitPtr.h.

Referenced by alignableDet(), alignmentPositionError(), isNull(), and operator=().

theAliDetUnit

AlignableDetUnit* AlignableDetOrUnitPtr::theAliDetUnit

private

Pointer to Alignable if it is a DetUnit.

Definition at line 94 of file AlignableDetOrUnitPtr.h.

Referenced by alignableDetUnit(), alignmentPositionError(), isNull(), and operator=().