OPAL (Object Oriented Parallel Accelerator Library)  2021.1.99
OPAL
OpalProbe.h
Go to the documentation of this file.
1 //
2 // Class OpalProbe
3 // The Probe element.
4 //
5 // Copyright (c) 200x - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
6 // All rights reserved
7 //
8 // This file is part of OPAL.
9 //
10 // OPAL is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with OPAL. If not, see <https://www.gnu.org/licenses/>.
17 //
18 #ifndef OPAL_OpalProbe_HH
19 #define OPAL_OpalProbe_HH
20 
21 #include "Elements/OpalElement.h"
22 
23 class OpalWake;
24 
25 class OpalProbe: public OpalElement {
26 
27 public:
28 
30  enum {
31  XSTART = COMMON, // Start of x coordinate
32  XEND, // End of x coordinate
33  YSTART, // Start of y coordinate
34  YEND, // End of y coordinate
35  WIDTH, // Width of the probe
36  STEP, // Step size of the probe
37  SIZE
38  };
40  OpalProbe();
41 
42  virtual ~OpalProbe();
43 
45  virtual OpalProbe *clone(const std::string &name);
46 
48  virtual void update();
49 
50 private:
51 
52  // Not implemented.
53  OpalProbe(const OpalProbe &);
54  void operator=(const OpalProbe &);
55 
56  // Clone constructor.
57  OpalProbe(const std::string &name, OpalProbe *parent);
58 
60 };
61 
62 #endif // OPAL_OpalProbe_HH
const std::string name
OpalProbe(const OpalProbe &)
void operator=(const OpalProbe &)
OpalProbe()
Exemplar constructor.
Definition: OpalProbe.cpp:26
OpalWake * owk_m
Definition: OpalProbe.h:59
virtual ~OpalProbe()
Definition: OpalProbe.cpp:57
virtual OpalProbe * clone(const std::string &name)
Make clone.
Definition: OpalProbe.cpp:62
virtual void update()
Update the embedded CLASSIC probe.
Definition: OpalProbe.cpp:67