1\subsection{beamconf Struct Reference}
2\label{structbeamconf}\index{beamconf@{beamconf}}
3{\tt \#include $<$bpm\_\-interface.h$>$}
4
5Collaboration diagram for beamconf:\nopagebreak
6\begin{figure}[H]
7\begin{center}
8\leavevmode
9\includegraphics[width=59pt]{structbeamconf__coll__graph}
10\end{center}
11\end{figure}
12
13
14\subsubsection{Detailed Description}
15This structure contains the global beam parameters as well as a pointer to the array of bunches
16
17Definition at line 227 of file bpm\_\-interface.h.\subsubsection*{Data Fields}
18\begin{CompactItemize}
19\item
20int {\bf train\_\-num}
21\item
22double {\bf beamrate}
23\item
24double {\bf bunchrate}
25\item
26int {\bf nbunches}
27\item
28{\bf bunchconf\_\-t} $\ast$ {\bf bunch}
29\item
30double {\bf position} [2]
31\item
32double {\bf positionsigma} [2]
33\item
34double {\bf slope} [2]
35\item
36double {\bf slopesigma} [2]
37\item
38double {\bf tilt} [2]
39\item
40double {\bf tiltsigma} [2]
41\item
42double {\bf bunchlength}
43\item
44double {\bf bunchlengthsigma}
45\item
46double {\bf energy}
47\item
48double {\bf energysigma}
49\item
50double {\bf charge}
51\item
52double {\bf chargesigma}
53\end{CompactItemize}
54
55
56\subsubsection{Field Documentation}
57\index{beamconf@{beamconf}!train\_\-num@{train\_\-num}}
58\index{train\_\-num@{train\_\-num}!beamconf@{beamconf}}
59\paragraph[train\_\-num]{\setlength{\rightskip}{0pt plus 5cm}int {\bf beamconf::train\_\-num}}\hfill\label{structbeamconf_f25a9f8d65fa4f04f9050414e0dcf891}
60
61
62seq number of the train (evt num)
63
64Definition at line 228 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!beamrate@{beamrate}}
65\index{beamrate@{beamrate}!beamconf@{beamconf}}
66\paragraph[beamrate]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::beamrate}}\hfill\label{structbeamconf_9452259b166a06292909dd94e87bf9ae}
67
68
69beam repetition rate (train to train)
70
71Definition at line 230 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!bunchrate@{bunchrate}}
72\index{bunchrate@{bunchrate}!beamconf@{beamconf}}
73\paragraph[bunchrate]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::bunchrate}}\hfill\label{structbeamconf_21abb80770607c1d48fef708c5dc4ebd}
74
75
76bunch repetition rate (in the train)
77
78Definition at line 231 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!nbunches@{nbunches}}
79\index{nbunches@{nbunches}!beamconf@{beamconf}}
80\paragraph[nbunches]{\setlength{\rightskip}{0pt plus 5cm}int {\bf beamconf::nbunches}}\hfill\label{structbeamconf_3957367666e4d2132d8a662941276f3a}
81
82
83number of bunches per train
84
85Definition at line 232 of file bpm\_\-interface.h.
86
87Referenced by generate\_\-bpmsignal(), and get\_\-bpmhits().\index{beamconf@{beamconf}!bunch@{bunch}}
88\index{bunch@{bunch}!beamconf@{beamconf}}
89\paragraph[bunch]{\setlength{\rightskip}{0pt plus 5cm}{\bf bunchconf\_\-t}$\ast$ {\bf beamconf::bunch}}\hfill\label{structbeamconf_9ded2879131ef6960f2c63893353c885}
90
91
92list of pointers to the bunch conf structures
93
94Definition at line 234 of file bpm\_\-interface.h.
95
96Referenced by generate\_\-bpmsignal(), and get\_\-bpmhits().\index{beamconf@{beamconf}!position@{position}}
97\index{position@{position}!beamconf@{beamconf}}
98\paragraph[position]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::position}[2]}\hfill\label{structbeamconf_26b00990a201ad20363ff2affe6792fa}
99
100
101beam position at the origin
102
103Definition at line 236 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!positionsigma@{positionsigma}}
104\index{positionsigma@{positionsigma}!beamconf@{beamconf}}
105\paragraph[positionsigma]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::positionsigma}[2]}\hfill\label{structbeamconf_3fd6fab4b89235e0a27d3733676f8eca}
106
107
108position spread at the origin
109
110Definition at line 237 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!slope@{slope}}
111\index{slope@{slope}!beamconf@{beamconf}}
112\paragraph[slope]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::slope}[2]}\hfill\label{structbeamconf_71c30c68495a26878183645035cb8677}
113
114
115beam slope at the origin
116
117Definition at line 239 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!slopesigma@{slopesigma}}
118\index{slopesigma@{slopesigma}!beamconf@{beamconf}}
119\paragraph[slopesigma]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::slopesigma}[2]}\hfill\label{structbeamconf_40ab197475399c5bb01b5abe25dee3d9}
120
121
122slope spread at the origin
123
124Definition at line 240 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!tilt@{tilt}}
125\index{tilt@{tilt}!beamconf@{beamconf}}
126\paragraph[tilt]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::tilt}[2]}\hfill\label{structbeamconf_7465dd8acdcfce91e185a075334e2300}
127
128
129bunch tilt at the origin
130
131Definition at line 242 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!tiltsigma@{tiltsigma}}
132\index{tiltsigma@{tiltsigma}!beamconf@{beamconf}}
133\paragraph[tiltsigma]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::tiltsigma}[2]}\hfill\label{structbeamconf_64040fb7876b2b4b8969154ab4aa387d}
134
135
136tilt spread at the origin
137
138Definition at line 243 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!bunchlength@{bunchlength}}
139\index{bunchlength@{bunchlength}!beamconf@{beamconf}}
140\paragraph[bunchlength]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::bunchlength}}\hfill\label{structbeamconf_77503373031b8d15c31f697e8b8f5257}
141
142
143bunch length at the origin
144
145Definition at line 245 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!bunchlengthsigma@{bunchlengthsigma}}
146\index{bunchlengthsigma@{bunchlengthsigma}!beamconf@{beamconf}}
147\paragraph[bunchlengthsigma]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::bunchlengthsigma}}\hfill\label{structbeamconf_166c8fdd8f3720c15faa4ba77b234d2c}
148
149
150length spread at the origin
151
152Definition at line 246 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!energy@{energy}}
153\index{energy@{energy}!beamconf@{beamconf}}
154\paragraph[energy]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::energy}}\hfill\label{structbeamconf_259020346afa58ec8360e5098e8d9ab4}
155
156
157beam energy (in GeV) at the origin
158
159Definition at line 248 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!energysigma@{energysigma}}
160\index{energysigma@{energysigma}!beamconf@{beamconf}}
161\paragraph[energysigma]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::energysigma}}\hfill\label{structbeamconf_3a7e535010155e32742b08a4a7b68415}
162
163
164beam energy spread
165
166Definition at line 249 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!charge@{charge}}
167\index{charge@{charge}!beamconf@{beamconf}}
168\paragraph[charge]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::charge}}\hfill\label{structbeamconf_c06ea1a62a94875a08d0ff3ffeed5b18}
169
170
171bunch charge (in nC)
172
173Definition at line 250 of file bpm\_\-interface.h.\index{beamconf@{beamconf}!chargesigma@{chargesigma}}
174\index{chargesigma@{chargesigma}!beamconf@{beamconf}}
175\paragraph[chargesigma]{\setlength{\rightskip}{0pt plus 5cm}double {\bf beamconf::chargesigma}}\hfill\label{structbeamconf_2bd344a9266ed88379a987c5a845f986}
176
177
178charge spread
179
180Definition at line 251 of file bpm\_\-interface.h.
181
182The documentation for this struct was generated from the following file:\begin{CompactItemize}
183\item
184bpminterface/{\bf bpm\_\-interface.h}\end{CompactItemize}
185