| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // G4VTrajectoryPoint
27 //
28 // Class description:
29 //
30 // This class is the abstract base class representing the point
31 // forming a trajectory. It includes information of a the point.
32
33 // Contact:
34 // Questions and comments to this code should be sent to
35 // Katsuya Amako (e-mail: Katsuya.Amako@kek.jp)
36 // Takashi Sasaki (e-mail: Takashi.Sasaki@kek.jp)
37 // --------------------------------------------------------------------
38 #ifndef G4VTrajectoryPoint_hh
39 #define G4VTrajectoryPoint_hh 1
40
41 #include "G4ThreeVector.hh"
42 #include "globals.hh"
43
44 #include <map>
45 #include <vector>
46
47 class G4AttDef;
48 class G4AttValue;
49
50 class G4VTrajectoryPoint
51 {
52 public:
53 // Constructor/Destructor
54 G4VTrajectoryPoint() = default;
55 virtual ~G4VTrajectoryPoint() = default;
56
57 // Equality operator
58 G4bool operator==(const G4VTrajectoryPoint& right) const { return (this == &right); }
59
60 // Return point position
61 virtual const G4ThreeVector GetPosition() const = 0;
62
63 // Get method for a vector of auxiliary points.
64 // If implemented by a derived class, returns a pointer to a list
65 // of auxiliary points, e.g., intermediate points used during the
66 // calculation of the step that can be used for drawing a smoother
67 // trajectory. The user must test the validity of this pointer
68 virtual const std::vector<G4ThreeVector>* GetAuxiliaryPoints() const { return nullptr; }
69
70 // Get method for HEPRep style attribute definitions.
71 // If implemented by a derived class, returns a pointer to a map of
72 // attribute definitions for the attribute values below. The user
73 // must test the validity of this pointer. See G4Trajectory for an
74 // example of a concrete implementation of this method
75 virtual const std::map<G4String, G4AttDef>* GetAttDefs() const { return nullptr; }
76
77 // Get method for HEPRep style attribute values.
78 // If implemented by a derived class, returns a pointer to a list
79 // of attribute values suitable, e.g., for picking. Each must
80 // refer to an attribute definition in the above map; its name is
81 // the key. The user must test the validity of this pointer (it
82 // must be non-zero and conform to the G4AttDefs, which may be
83 // checked with G4AttCheck) and delete the list after use. See
84 // G4Trajectory for an example of a concrete implementation of this
85 // method and G4VTrajectory::ShowTrajectory() for an example of its use.
86 virtual std::vector<G4AttValue>* CreateAttValues() const { return nullptr; }
87 };
88
89 #endif
90