BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
BDSModulatorInfo.hh
1/*
2Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway,
3University of London 2001 - 2023.
4
5This file is part of BDSIM.
6
7BDSIM is free software: you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published
9by the Free Software Foundation version 3 of the License.
10
11BDSIM is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with BDSIM. If not, see <http://www.gnu.org/licenses/>.
18*/
19#ifndef BDSMODULATORINFO_H
20#define BDSMODULATORINFO_H
21
22#include "BDSModulatorType.hh"
23
24#include "G4Types.hh"
25
33{
34public:
36 BDSModulatorInfo() = delete;
38 BDSModulatorInfo(BDSModulatorType modulatorTypeIn,
39 G4double frequencyIn,
40 G4double phaseIn = 0,
41 G4double tOffsetIn = 0,
42 G4double scaleIn = 1.0,
43 G4double amplitudeOffsetIn = 0,
44 G4double T0In = 0,
45 G4double T1In = 0);
46
47 ~BDSModulatorInfo() = default;
48
50 friend std::ostream& operator<< (std::ostream &out, BDSModulatorInfo const &info);
51
54 G4double frequency;
55 G4double phase;
56 G4double tOffset;
57 G4double scale;
59 G4double T0;
60 G4double T1;
62
63 G4String nameOfParserDefinition;
64};
65
66#endif
Holder class for all information required to describe a modulator.
G4double T1
Public member for direct access.
friend std::ostream & operator<<(std::ostream &out, BDSModulatorInfo const &info)
output stream
BDSModulatorInfo()=delete
Deleted default constructor to ensure one of supplied constructors is used.
G4double frequency
Public member for direct access.
BDSModulatorType modulatorType
Public member for direct access.
G4double T0
Public member for direct access.
G4double phase
Public member for direct access.
G4double tOffset
Public member for direct access.
G4double scale
Public member for direct access.
G4double amplitudeOffset
Public member for direct access.