AlignableDetOrUnitPtr

Macros

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
#ifndef Alignment_CommonAlignment_AlignableDetOrUnitPtr_H
#define Alignment_CommonAlignment_AlignableDetOrUnitPtr_H

/** \class AlignableDetOrUnitPtr
 *
 * 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 $)
 */

class Alignable;
class AlignableBeamSpot;
class AlignableDet;
class AlignableDetUnit;
class AlignmentPositionError;

class AlignableDetOrUnitPtr {
public:
  /// Constructor from AlignableBeamSpot* (non-explicit: for automatic conversions)
  inline AlignableDetOrUnitPtr(AlignableBeamSpot* aliBeamSpot)
      : theAliBeamSpot(aliBeamSpot), theAliDet(nullptr), theAliDetUnit(nullptr) {}

  /// Constructor from AlignableDet* (non-explicit: for automatic conversions)
  inline AlignableDetOrUnitPtr(AlignableDet* aliDet)
      : theAliBeamSpot(nullptr), theAliDet(aliDet), theAliDetUnit(nullptr) {}

  /// Constructor from AlignableDetUnit* (non-explicit: for automatic conversions)
  inline AlignableDetOrUnitPtr(AlignableDetUnit* aliDetUnit)
      : theAliBeamSpot(nullptr), theAliDet(nullptr), theAliDetUnit(aliDetUnit) {}
  /// Non-virtual destructor: do not use as base class
  inline ~AlignableDetOrUnitPtr() {}

  inline AlignableDetOrUnitPtr& operator=(AlignableBeamSpot* aliBeamSpot) {
    theAliBeamSpot = aliBeamSpot;
    theAliDet = nullptr;
    theAliDetUnit = nullptr;
    return *this;
  }
  inline AlignableDetOrUnitPtr& operator=(AlignableDet* aliDet) {
    theAliBeamSpot = nullptr;
    theAliDet = aliDet;
    theAliDetUnit = nullptr;
    return *this;
  }
  inline AlignableDetOrUnitPtr& operator=(AlignableDetUnit* aliDetUnit) {
    theAliBeamSpot = nullptr;
    theAliDet = nullptr;
    theAliDetUnit = aliDetUnit;
    return *this;
  }
  // Default operator= and default copy constructor are fine, no need to code them here.

  // conversions to Alignable* etc.
  operator Alignable*();
  operator const Alignable*() const;
  inline Alignable* operator->() { return this->operator Alignable*(); }
  inline const Alignable* operator->() const { return this->operator const Alignable*(); }
  // explicit call if needed:
  inline Alignable* alignable() { return this->operator Alignable*(); }
  inline const Alignable* alignable() const { return this->operator const Alignable*(); }

  // explicit access to specific types
  inline AlignableBeamSpot* alignableBeamSpot() { return theAliBeamSpot; }
  inline const AlignableBeamSpot* alignableBeamSpot() const { return theAliBeamSpot; }
  inline AlignableDet* alignableDet() { return theAliDet; }
  inline const AlignableDet* alignableDet() const { return theAliDet; }
  inline AlignableDetUnit* alignableDetUnit() { return theAliDetUnit; }
  inline const AlignableDetUnit* alignableDetUnit() const { return theAliDetUnit; }

  /// check for empty pointer
  inline bool isNull() const { return (!theAliBeamSpot && !theAliDet && !theAliDetUnit); }

  // interface to methods specific for AlignableDet(Unit),
  // slightly breaking idea of 'pointerness' of this class
  /// alignment position error (see comments in specific classes)
  const AlignmentPositionError* alignmentPositionError() const;

private:
  AlignableBeamSpot* theAliBeamSpot;  ///< Pointer to Alignable if it is the beam spot
  AlignableDet* theAliDet;            ///< Pointer to Alignable if it is a Det
  AlignableDetUnit* theAliDetUnit;    ///< Pointer to Alignable if it is a DetUnit
};

#endif