OPAL (Object Oriented Parallel Accelerator Library)  2021.1.99
OPAL
OpalLocalCylindricalOffset.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, Chris Rogers
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  * 1. Redistributions of source code must retain the above copyright notice,
7  * this list of conditions and the following disclaimer.
8  * 2. Redistributions in binary form must reproduce the above copyright notice,
9  * this list of conditions and the following disclaimer in the documentation
10  * and/or other materials provided with the distribution.
11  * 3. Neither the name of STFC nor the names of its contributors may be used to
12  * endorse or promote products derived from this software without specific
13  * prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  * POSSIBILITY OF SUCH DAMAGE.
26  */
27 
29 
30 #include <string>
31 
32 #include "AbsBeamline/Offset.h"
33 #include "Elements/OpalElement.h"
34 
35 #include "Attributes/Attributes.h"
36 
37 namespace OpalOffset {
38 
40  std::string("The \"LOCAL_CYLINDRICAL_OFFSET\" element defines an offset")+
41  std::string("in cylindrical coordinates, relative to the last placed ")+
42  std::string("element. All angles are defined in the midplane.");
43 
45  : OpalElement(int(SIZE),
46  "LOCAL_CYLINDRICAL_OFFSET",
47  doc_string.c_str()) {
49  "Angle between the previous element and the displacement vector [rad].");
50  itsAttr[THETA_OUT] = Attributes::makeReal("THETA_OUT",
51  "Angle between the displacement vector and the next element [rad].");
52  itsAttr[LENGTH] = Attributes::makeReal("LENGTH", "Length of the offset [m].");
53 
55 }
56 
58  return new OpalLocalCylindricalOffset(name, this);
59 }
60 
61 void OpalLocalCylindricalOffset::print(std::ostream& out) const {
62  OpalElement::print(out);
63 }
64 
66  OpalElement(name, parent) {
67 }
68 
70 
72  // getOpalName() comes from AbstractObjects/Object.h
73  std::string name = getOpalName();
74  double length = Attributes::getReal(itsAttr[LENGTH]);
75  double theta_in = Attributes::getReal(itsAttr[THETA_IN]);
76  double theta_out = Attributes::getReal(itsAttr[THETA_OUT]);
78  theta_in,
79  theta_out,
80  length));
81  // is this a memory leak?
82  setElement(off);
83 }
84 
85 }
@ SIZE
Definition: IndexMap.cpp:174
const std::string name
double getReal(const Attribute &attr)
Return real value.
Definition: Attributes.cpp:252
Attribute makeReal(const std::string &name, const std::string &help)
Make real attribute.
Definition: Attributes.cpp:240
void setElement(ElementBase *)
Assign new CLASSIC element.
Definition: Element.h:125
const std::string & getOpalName() const
Return object name.
Definition: Object.cpp:281
std::vector< Attribute > itsAttr
The object attributes.
Definition: Object.h:216
Definition: Offset.h:66
static Offset localCylindricalOffset(std::string name, double theta_in, double theta_out, double displacement)
Definition: Offset.cpp:252
virtual void print(std::ostream &) const
Print the object.
void registerOwnership() const
virtual OpalLocalCylindricalOffset * clone(const std::string &name)
virtual void print(std::ostream &) const