OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
SourceRep.h
Go to the documentation of this file.
1 #ifndef CLASSIC_SOURCEREP_HH
2 #define CLASSIC_SOURCEREP_HH
3 
4 // ------------------------------------------------------------------------
5 // $RCSfile: SourceRep.h,v $
6 // ------------------------------------------------------------------------
7 // $Revision: 1.1.1.1 $
8 // ------------------------------------------------------------------------
9 // Copyright: see Copyright.readme
10 // ------------------------------------------------------------------------
11 //
12 // Class: SourceRep
13 //
14 // ------------------------------------------------------------------------
15 // Class category: BeamlineCore
16 // ------------------------------------------------------------------------
17 //
18 // $Date: 2000/03/27 09:32:34 $
19 // $Author: fci $
20 //
21 // ------------------------------------------------------------------------
22 
23 #include "AbsBeamline/Source.h"
25 #include "Fields/NullField.h"
26 
27 
28 // Class SourceRep
29 // ------------------------------------------------------------------------
31 
32 class SourceRep: public Source {
33 
34 public:
35 
37  explicit SourceRep(const std::string &name);
38 
39  SourceRep();
40  SourceRep(const SourceRep &);
41  virtual ~SourceRep();
42 
44  // Return an identical deep copy of the element.
45  virtual ElementBase *clone() const;
46 
48  // This method constructs a Channel permitting read/write access to
49  // the attribute [b]aKey[/b] and returns it.
50  // If the attribute does not exist, it returns NULL.
51  virtual Channel *getChannel(const std::string &aKey, bool = false);
52 
54  // Version for non-constant object.
55  virtual NullField &getField();
56 
58  // Version for constant object.
59  virtual const NullField &getField() const;
60 
62  // Version for non-constant object.
63  virtual StraightGeometry &getGeometry();
64 
66  // Version for constant object.
67  virtual const StraightGeometry &getGeometry() const;
68 
70  // Return the image of the element, containing the name and type string
71  // of the element, and a copy of the user-defined attributes.
72  virtual ElementImage *getImage() const;
73 
74 private:
75 
76  // Not implemented.
77  void operator=(const SourceRep &);
78 
79  // The zero magnetic field.
81 
84 };
85 
86 #endif // CLASSIC_SOURCEREP_HH
Definition: Source.h:12
Interface for basic beam line object.
Definition: ElementBase.h:128
A zero electromagnetic field.
Definition: NullField.h:30
virtual StraightGeometry & getGeometry()
Get geometry.
Definition: SourceRep.cpp:74
virtual NullField & getField()
Get field.
Definition: SourceRep.cpp:66
virtual ElementBase * clone() const
Return clone.
Definition: SourceRep.cpp:51
An image of an element.
Definition: ElementImage.h:35
StraightGeometry geometry
The solenoid geometry.
Definition: SourceRep.h:83
NullField field
Definition: SourceRep.h:80
A geometry representing a straight line.
virtual ElementImage * getImage() const
Construct an image.
Definition: SourceRep.cpp:83
Abstract interface for read/write access to variable.
Definition: Channel.h:32
const std::string name
virtual Channel * getChannel(const std::string &aKey, bool=false)
Construct a read/write channel.
Definition: SourceRep.cpp:56
Tepresentation for a solenoid magnet.
Definition: SourceRep.h:32
void operator=(const SourceRep &)
virtual ~SourceRep()
Definition: SourceRep.cpp:47