OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
OpalLocalCartesianOffset.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"
35
37
38namespace OpalOffset {
39
41 std::string("The \"LOCAL_CARTESIAN_OFFSET\" element defines an offset")+
42 std::string("in cartesian coordinates, relative to the last placed ")+
43 std::string("element.");
44
46 : OpalElement(int(SIZE),
47 "LOCAL_CARTESIAN_OFFSET",
48 doc_string.c_str()) {
50 "x component of position of end of the offset in coordinate system of the end of the upstream element [m].");
52 "y component of position of end of the offset in coordinate system of the end of the upstream element [m].");
54 "x component of normal of end of the offset in coordinate system of the end of the upstream element [m].");
56 "y component of normal of end of the offset in coordinate system of the end of the upstream element [m].");
57
59
60 setElement(new Offset("LOCAL_CARTESIAN_OFFSET"));
61}
62
64 return new OpalLocalCartesianOffset(this->getOpalName(), this);
65}
66
67
69 return new OpalLocalCartesianOffset(name, this);
70}
71
72void OpalLocalCartesianOffset::print(std::ostream& out) const {
74}
75
77 OpalElement(name, parent) {
79}
80
82
84 // getOpalName() comes from AbstractObjects/Object.h
85 Offset *offset = dynamic_cast<Offset*>(getElement());
86 std::string name = getOpalName();
91 *offset = Offset(Offset::localCartesianOffset(name, pos, norm));
92 setElement(offset);
93}
94}
@ 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
ElementBase * getElement() const
Return the embedded CLASSIC element.
Definition: Element.h:120
void setElement(ElementBase *)
Assign new CLASSIC element.
Definition: Element.h:125
const std::string & getOpalName() const
Return object name.
Definition: Object.cpp:310
std::vector< Attribute > itsAttr
The object attributes.
Definition: Object.h:216
Definition: Offset.h:66
static Offset localCartesianOffset(std::string name, Vector_t end_position, Vector_t end_direction)
Definition: Offset.cpp:283
virtual void print(std::ostream &) const
Print the object.
void registerOwnership() const
virtual void print(std::ostream &) const
virtual OpalLocalCartesianOffset * clone()