include/Geant4/G4VUserTrackInformation.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 // G4VUserTrackInformation
0027 //
0028 // Class description:
0029 //
0030 // Abstract class from which the user can derive a concrete class for
0031 // storing user's information associated with a G4Track object.
0032 //
0033 // It is user's responsibility:
0034 //   1) To construct a concrete class object and set the pointer to the
0035 //      proper G4Track
0036 //   2) Concrete class derived from this class is expected to use G4Allocator
0037 //      for memory management or something equivarent for performance reason
0038 //
0039 // To set a pointer of a concrete class object to G4Track in
0040 // G4UserTrackingAction concrete implementation, given the G4Track
0041 // object is available only by "pointer to const", SetUserTrackInformation()
0042 // method of G4TrackingManager is available.
0043 //
0044 // The concrete class object is deleted by Geant4 kernel when the
0045 // associated G4Track is deleted.
0046
0047 // Author: Makoto Asai, 2 June 2000
0048 // --------------------------------------------------------------------
0049 #ifndef G4VUserTrackInformation_hh
0050 #define G4VUserTrackInformation_hh 1
0051
0052 #include "globals.hh"
0053
0054 class G4VUserTrackInformation
0055 {
0056   public:
0057
0058     G4VUserTrackInformation() = default;
0059     G4VUserTrackInformation(const G4String& infoType);
0060       // String is provided to indicate the Type of UserTrackInfo class
0061       // User is recommended to set the type of his/her class
0062
0063     G4VUserTrackInformation(const G4VUserTrackInformation&);
0064     G4VUserTrackInformation& operator=(const G4VUserTrackInformation&);
0065
0066     virtual ~G4VUserTrackInformation();
0067
0068     virtual void Print() const {};
0069
0070     const G4String& GetType() const;
0071       // Get Type of this UserTrackInfo
0072
0073   protected:
0074
0075     G4String* pType = nullptr;
0076 };
0077
0078 #endif