OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
CyclotronValleyRep.h
Go to the documentation of this file.
1 #ifndef CLASSIC_CyclotronValleyRep_HH
2 #define CLASSIC_CyclotronValleyRep_HH
3 
4 // ------------------------------------------------------------------------
5 // $RCSfile: CyclotronValleyRep.h,v $
6 // ------------------------------------------------------------------------
7 // $Revision: 1.1.1.1 $
8 // ------------------------------------------------------------------------
9 // Copyright: see Copyright.readme
10 // ------------------------------------------------------------------------
11 //
12 // Class: CyclotronValleyRep
13 // Defines a representation for a Cyclotron Valley.
14 //
15 // ------------------------------------------------------------------------
16 // Class category: BeamlineCore
17 // ------------------------------------------------------------------------
18 //
19 // $Date: 2010/12/8 14:57:34 $
20 // $Author: Chuan Wang $
21 //
22 // ------------------------------------------------------------------------
26 
27 
28 // Class CyclotronValleyRep
29 // ------------------------------------------------------------------------
31 
33 
34 public:
35 
37  explicit CyclotronValleyRep(const std::string &name);
38 
41  virtual ~CyclotronValleyRep();
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 AcceleratingField &getField();
56 
58  // Version for constant object.
59  virtual const AcceleratingField &getField() const;
60 
62  // Return the element geometry.
63  // Version for non-constant object.
64  virtual StraightGeometry &getGeometry();
65 
67  // Return the element geometry
68  // Version for constant object.
69  virtual const StraightGeometry &getGeometry() const;
70 
72  // Return the image of the element, containing the name and type string
73  // of the element, and a copy of the user-defined attributes.
74  virtual ElementImage *getImage() const;
75 
76  private:
77 
78  // Not implemented.
79  void operator=(const CyclotronValleyRep &);
80 
83 
86 };
87 
88 #endif // CLASSIC_CyclotronValleyRep_HH
Interface for basic beam line object.
Definition: ElementBase.h:128
StraightGeometry geometry
The cavity's geometry.
virtual AcceleratingField & getField()
Get field.
virtual Channel * getChannel(const std::string &aKey, bool=false)
Construct a read/write channel.
AcceleratingField field
The cavity's field.
An image of an element.
Definition: ElementImage.h:35
Interface for cyclotron valley.
A geometry representing a straight line.
Abstract interface for read/write access to variable.
Definition: Channel.h:32
void operator=(const CyclotronValleyRep &)
virtual ElementImage * getImage() const
Construct an image.
Representation for a Cyclotron Valley.
const std::string name
virtual StraightGeometry & getGeometry()
Get geometry.
virtual ElementBase * clone() const
Return clone.