Geant4  10.01
G4VTrajectoryPoint.hh
Go to the documentation of this file.
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 //
27 // $Id: G4VTrajectoryPoint.hh 66241 2012-12-13 18:34:42Z gunter $
28 //
29 //---------------------------------------------------------------
30 //
31 // G4VTrajectoryPoint.hh
32 //
33 // class description:
34 // This class is the abstract base class which represents the point
35 // which consists of a trajectory.
36 // It includes information of a the point.
37 //
38 // ---------------------------------------------------------------
39 
40 #ifndef G4VTrajectoryPoint_h
41 #define G4VTrajectoryPoint_h 1
42 
43 #include "globals.hh"
44 #include <vector>
45 #include <map>
46 #include "G4ThreeVector.hh"
47 
48 class G4AttDef;
49 class G4AttValue;
50 
52 {
53  public: // with description
54 
55  // Constructor/Destructor
57  virtual ~G4VTrajectoryPoint();
58 
59  // Operators
61 
62  // Get/Set functions
63  virtual const G4ThreeVector GetPosition() const = 0;
64 
65  // Get method for a vector of auxiliary points
66  virtual const std::vector<G4ThreeVector>* GetAuxiliaryPoints() const
67  { return 0; }
68  // If implemented by a derived class, returns a pointer to a list
69  // of auxiliary points, e.g., intermediate points used during the
70  // calculation of the step that can be used for drawing a smoother
71  // trajectory. The user must test the validity of this pointer.
72 
73  // Get method for HEPRep style attribute definitions
74  virtual const std::map<G4String,G4AttDef>* GetAttDefs() const
75  { return 0; }
76  // If implemented by a derived class, returns a pointer to a map of
77  // attribute definitions for the attribute values below. The user
78  // must test the validity of this pointer. See G4Trajectory for an
79  // example of a concrete implementation of this method.
80 
81  // Get method for HEPRep style attribute values
82  virtual std::vector<G4AttValue>* CreateAttValues() const
83  { return 0; }
84  // If implemented by a derived class, returns a pointer to a list
85  // of attribute values suitable, e.g., for picking. Each must
86  // refer to an attribute definition in the above map; its name is
87  // the key. The user must test the validity of this pointer (it
88  // must be non-zero and conform to the G4AttDefs, which may be
89  // checked with G4AttCheck) and delete the list after use. See
90  // G4Trajectory for an example of a concrete implementation of this
91  // method and G4VTrajectory::ShowTrajectory for an example of its
92  // use.
93 
94 };
95 
96 #endif
97 
CLHEP::Hep3Vector G4ThreeVector
virtual const std::vector< G4ThreeVector > * GetAuxiliaryPoints() const
virtual const std::map< G4String, G4AttDef > * GetAttDefs() const
virtual std::vector< G4AttValue > * CreateAttValues() const
bool G4bool
Definition: G4Types.hh:79
G4bool operator==(const G4VTrajectoryPoint &right) const
virtual const G4ThreeVector GetPosition() const =0