OPAL (Object Oriented Parallel Accelerator Library)  2024.1
OPAL
OpalGlobalCartesianOffset.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 
39 const std::string OpalGlobalCartesianOffset::doc_string =
40 "The \"GLOBAL_CARTESIAN_OFFSET\" element defines an offset in cartesian "
41 "coordinates, relative to the origin of the coordinate system.";
42 
44  : OpalElement(int(SIZE),
45  "GLOBAL_CARTESIAN_OFFSET",
46  doc_string.c_str()) {
47  itsAttr[END_POSITION_X] = Attributes::makeReal("END_POSITION_X",
48  "x component of position of end of the offset in coordinate system of the end of the upstream element.");
49  itsAttr[END_POSITION_Y] = Attributes::makeReal("END_POSITION_Y",
50  "y component of position of end of the offset in coordinate system of the end of the upstream element.");
51  itsAttr[END_NORMAL_X] = Attributes::makeReal("END_NORMAL_X",
52  "x component of normal of end of the offset in coordinate system of the end of the upstream element.");
53  itsAttr[END_NORMAL_Y] = Attributes::makeReal("END_NORMAL_Y",
54  "y component of normal of end of the offset in coordinate system of the end of the upstream element.");
55 
57 }
58 
60  return new OpalGlobalCartesianOffset(name, this);
61 }
62 
63 void OpalGlobalCartesianOffset::print(std::ostream& out) const {
64  OpalElement::print(out);
65 }
66 
68  OpalElement(name, parent) {
69 }
70 
72 
74  // getOpalName() comes from AbstractObjects/Object.h
75  std::string name = getOpalName();
80  Offset* off = new Offset(Offset::globalCartesianOffset(name, pos, norm));
81  // is this a memory leak?
82  setElement(off);
83 }
84 }
Attribute makeReal(const std::string &name, const std::string &help)
Make real attribute.
Definition: Attributes.cpp:240
virtual OpalGlobalCartesianOffset * clone(const std::string &name)
virtual void print(std::ostream &) const
Print the object.
Definition: Offset.h:53
void setElement(ElementBase *)
Assign new CLASSIC element.
Definition: Element.h:125
virtual void print(std::ostream &) const
const std::string & getOpalName() const
Return object name.
Definition: Object.cpp:310
std::vector< Attribute > itsAttr
The object attributes.
Definition: Object.h:216
const std::string name
double getReal(const Attribute &attr)
Return real value.
Definition: Attributes.cpp:252
void registerOwnership() const
static Offset globalCartesianOffset(const std::string &name, Vector_t end_position, Vector_t end_direction)
Definition: Offset.cpp:296