include/Geant4/G4EntanglementAuxInfo.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 //
0028 // --------------------------------------------------------------------
0029 // GEANT4 class header file
0030 //
0031 // Class Description:
0032 // Manages a clipboard for communicatimg between quantum entangled tracks.
0033 //
0034 // ------------------ G4EntanglementAuxInfo ------------------
0035 //
0036 // Author: J.Allison, May 2017
0037 //
0038 // --------------------------------------------------------------------
0039
0040 // Usage:
0041 //
0042 // This is a concrete class based on G4VAuxiliaryTrackInformation. It is
0043 // designed to hold a shared pointer to a "clip board".  The idea is to
0044 // provide an object - the clip board - that is common across all tracks
0045 // that have this track information and is deleted only when all tracks
0046 // have been tracked.
0047 //
0048 // See G4VEntanglementClipBoard.hh for more infromation.
0049
0050 #ifndef G4EntanglementAuxInfo_hh
0051 #define G4EntanglementAuxInfo_hh
0052
0053 #include "G4VAuxiliaryTrackInformation.hh"
0054
0055 #include <memory>
0056
0057 #include "G4VEntanglementClipBoard.hh"
0058
0059 class G4EntanglementAuxInfo : public G4VAuxiliaryTrackInformation {
0060
0061 public:
0062
0063   G4EntanglementAuxInfo
0064   (const std::shared_ptr<G4VEntanglementClipBoard>& clipBoard)
0065   : fEntanglementClipBoard(clipBoard) {}
0066
0067   ~G4EntanglementAuxInfo() {}
0068
0069   G4VEntanglementClipBoard* GetEntanglementClipBoard() const
0070   {return fEntanglementClipBoard.get();}
0071
0072 private:
0073
0074   std::shared_ptr<G4VEntanglementClipBoard> fEntanglementClipBoard;
0075
0076 };
0077
0078 #endif