Geant4 11.2.2
Toolkit for the simulation of the passage of particles through matter
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
G4VDigi.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//
28
29#ifndef G4VDigi_h
30#define G4VDigi_h 1
31
32#include "globals.hh"
33
34#include <map>
35#include <vector>
36
37class G4AttDef;
38class G4AttValue;
39
40// class description:
41//
42// This is the base class of digi object. The user should derive this
43// base class to make his/her own digi class. Two virtual method Draw()
44// and Print() can be implemented if the user wants these functionarities.
45// If a concrete digi class is used as a transient class, G4Allocator
46// must be used.
47
49{
50 public:
51 G4VDigi() = default;
52 virtual ~G4VDigi() = default;
53
54 G4bool operator==(const G4VDigi& right) const { return (this == &right); }
55
56 virtual void Draw(){};
57 virtual void Print(){};
58
59 // Returns pointer to map of attribute definitions for this digit
60 // Caller is responsible for checking validity of returned pointer.
61 // See `G4Trajectory` for a concrete implementation.
62 virtual const std::map<G4String, G4AttDef>* GetAttDefs() const { return nullptr; }
63
64 // Returns pointer to list of attributes for this digit
65 // Each attribute must correspond to a definition returned by `GetAffDefs`.
66 // Caller is responsible for checking validity of returned pointer.
67 // See `G4Trajectory` for a concrete implementation, and
68 // `G4VTrajectory::ShowTrajectory` for an example of its use.
69 virtual std::vector<G4AttValue>* CreateAttValues() const { return nullptr; }
70};
71
72#endif
bool G4bool
Definition G4Types.hh:86
virtual void Print()
Definition G4VDigi.hh:57
G4bool operator==(const G4VDigi &right) const
Definition G4VDigi.hh:54
virtual void Draw()
Definition G4VDigi.hh:56
G4VDigi()=default
virtual ~G4VDigi()=default
virtual const std::map< G4String, G4AttDef > * GetAttDefs() const
Definition G4VDigi.hh:62
virtual std::vector< G4AttValue > * CreateAttValues() const
Definition G4VDigi.hh:69