CYCAMORE
Loading...
Searching...
No Matches
build/cycamore/deploy_inst.h
Go to the documentation of this file.
1
2#line 1 "/cycamore/src/deploy_inst.h"
3#ifndef CYCAMORE_SRC_DEPLOY_INST_H_
4#define CYCAMORE_SRC_DEPLOY_INST_H_
5
6#include <utility>
7#include <set>
8#include <map>
9
10#include "cyclus.h"
11#include "cycamore_version.h"
12
13namespace cycamore {
14
15typedef std::map<int, std::vector<std::string> > BuildSched;
16
17// Builds and manages agents (facilities) according to a manually specified
18// deployment schedule. Deployed agents are automatically decommissioned at
19// the end of their lifetime. The user specifies a list of prototypes for
20// each and corresponding build times, number to build, and (optionally)
21// lifetimes. The same prototype can be specified multiple times with any
22// combination of the same or different build times, build number, and
23// lifetimes.
24class DeployInst :
25 public cyclus::Institution,
26 public cyclus::toolkit::CommodityProducerManager,
27 public cyclus::toolkit::Position {
28 #pragma cyclus note { "doc": "Builds and manages agents (facilities) according to a manually" " specified deployment schedule. Deployed agents are automatically" " decommissioned at the end of their lifetime. Deployed and" " decommissioned agents are registered and unregistered with a" " region. The user specifies a list of prototypes for" " each and corresponding build times, number to build, and (optionally)" " lifetimes. The same prototype can be specified multiple times with" " any combination of the same or different build times, build number," " and lifetimes. " }
29#line 38 "/cycamore/src/deploy_inst.h"
30 public:
31 DeployInst(cyclus::Context* ctx);
32
33 virtual ~DeployInst();
34
35 virtual std::string version() { return CYCAMORE_VERSION; }
36 virtual void InitFrom(cycamore::DeployInst* m) {
37 cyclus::Institution::InitFrom(m);
38 int rawcycpp_shape_prototypes[2] = {-1, -1};
39 cycpp_shape_prototypes = std::vector<int>(rawcycpp_shape_prototypes, rawcycpp_shape_prototypes + 2);
40 int rawcycpp_shape_build_times[2] = {-1, -1};
41 cycpp_shape_build_times = std::vector<int>(rawcycpp_shape_build_times, rawcycpp_shape_build_times + 2);
42 int rawcycpp_shape_n_build[2] = {-1, -1};
43 cycpp_shape_n_build = std::vector<int>(rawcycpp_shape_n_build, rawcycpp_shape_n_build + 2);
44 int rawcycpp_shape_lifetimes[2] = {-1, -1};
45 cycpp_shape_lifetimes = std::vector<int>(rawcycpp_shape_lifetimes, rawcycpp_shape_lifetimes + 2);
46 int rawcycpp_shape_latitude[1] = {-1};
47 cycpp_shape_latitude = std::vector<int>(rawcycpp_shape_latitude, rawcycpp_shape_latitude + 1);
48 int rawcycpp_shape_longitude[1] = {-1};
49 cycpp_shape_longitude = std::vector<int>(rawcycpp_shape_longitude, rawcycpp_shape_longitude + 1);
50 prototypes = m->prototypes;
51 build_times = m->build_times;
52 n_build = m->n_build;
53 lifetimes = m->lifetimes;
54 latitude = m->latitude;
55 longitude = m->longitude;
56 };
57#line 44 "/cycamore/src/deploy_inst.h"
58
59 virtual void InitFrom(cyclus::QueryableBackend* b) {
60 cyclus::Institution::InitFrom(b);
61 int rawcycpp_shape_prototypes[2] = {-1, -1};
62 cycpp_shape_prototypes = std::vector<int>(rawcycpp_shape_prototypes, rawcycpp_shape_prototypes + 2);
63 int rawcycpp_shape_build_times[2] = {-1, -1};
64 cycpp_shape_build_times = std::vector<int>(rawcycpp_shape_build_times, rawcycpp_shape_build_times + 2);
65 int rawcycpp_shape_n_build[2] = {-1, -1};
66 cycpp_shape_n_build = std::vector<int>(rawcycpp_shape_n_build, rawcycpp_shape_n_build + 2);
67 int rawcycpp_shape_lifetimes[2] = {-1, -1};
68 cycpp_shape_lifetimes = std::vector<int>(rawcycpp_shape_lifetimes, rawcycpp_shape_lifetimes + 2);
69 int rawcycpp_shape_latitude[1] = {-1};
70 cycpp_shape_latitude = std::vector<int>(rawcycpp_shape_latitude, rawcycpp_shape_latitude + 1);
71 int rawcycpp_shape_longitude[1] = {-1};
72 cycpp_shape_longitude = std::vector<int>(rawcycpp_shape_longitude, rawcycpp_shape_longitude + 1);
73 cyclus::QueryResult qr = b->Query("Info", NULL);
74 prototypes = qr.GetVal<std::vector< std::string > >("prototypes");
75 build_times = qr.GetVal<std::vector< int > >("build_times");
76 n_build = qr.GetVal<std::vector< int > >("n_build");
77 lifetimes = qr.GetVal<std::vector< int > >("lifetimes");
78 latitude = qr.GetVal<double>("latitude");
79 longitude = qr.GetVal<double>("longitude");
80 };
81
82 virtual void InfileToDb(cyclus::InfileTree* tree, cyclus::DbInit di) {
83 cyclus::Institution::InfileToDb(tree, di);
84 int rawcycpp_shape_prototypes[2] = {-1, -1};
85 cycpp_shape_prototypes = std::vector<int>(rawcycpp_shape_prototypes, rawcycpp_shape_prototypes + 2);
86 int rawcycpp_shape_build_times[2] = {-1, -1};
87 cycpp_shape_build_times = std::vector<int>(rawcycpp_shape_build_times, rawcycpp_shape_build_times + 2);
88 int rawcycpp_shape_n_build[2] = {-1, -1};
89 cycpp_shape_n_build = std::vector<int>(rawcycpp_shape_n_build, rawcycpp_shape_n_build + 2);
90 int rawcycpp_shape_lifetimes[2] = {-1, -1};
91 cycpp_shape_lifetimes = std::vector<int>(rawcycpp_shape_lifetimes, rawcycpp_shape_lifetimes + 2);
92 int rawcycpp_shape_latitude[1] = {-1};
93 cycpp_shape_latitude = std::vector<int>(rawcycpp_shape_latitude, rawcycpp_shape_latitude + 1);
94 int rawcycpp_shape_longitude[1] = {-1};
95 cycpp_shape_longitude = std::vector<int>(rawcycpp_shape_longitude, rawcycpp_shape_longitude + 1);
96 cyclus::InfileTree* sub = tree->SubTree("config/*");
97 int i;
98 int n;
99 {
100 cyclus::InfileTree* bub = sub->SubTree("prototypes", 0);
101 cyclus::InfileTree* sub = bub;
102 int n1 = sub->NMatches("val");
103 std::vector< std::string > prototypes_val;
104 prototypes_val.resize(n1);
105 for (int i1 = 0; i1 < n1; ++i1) {
106 std::string elem;
107 {
108 std::string elem_in = cyclus::Query<std::string>(sub, "val", i1);
109 elem = elem_in;
110 }
111 prototypes_val[i1] = elem;
112 }
113 prototypes = prototypes_val;
114 }
115 {
116 cyclus::InfileTree* bub = sub->SubTree("build_times", 0);
117 cyclus::InfileTree* sub = bub;
118 int n1 = sub->NMatches("val");
119 std::vector< int > build_times_val;
120 build_times_val.resize(n1);
121 for (int i1 = 0; i1 < n1; ++i1) {
122 int elem;
123 {
124 int elem_in = cyclus::Query<int>(sub, "val", i1);
125 elem = elem_in;
126 }
127 build_times_val[i1] = elem;
128 }
129 build_times = build_times_val;
130 }
131 {
132 cyclus::InfileTree* bub = sub->SubTree("n_build", 0);
133 cyclus::InfileTree* sub = bub;
134 int n1 = sub->NMatches("val");
135 std::vector< int > n_build_val;
136 n_build_val.resize(n1);
137 for (int i1 = 0; i1 < n1; ++i1) {
138 int elem;
139 {
140 int elem_in = cyclus::Query<int>(sub, "val", i1);
141 elem = elem_in;
142 }
143 n_build_val[i1] = elem;
144 }
145 n_build = n_build_val;
146 }
147 if (sub->NMatches("lifetimes") > 0) {
148 {
149 cyclus::InfileTree* bub = sub->SubTree("lifetimes", 0);
150 cyclus::InfileTree* sub = bub;
151 int n1 = sub->NMatches("val");
152 std::vector< int > lifetimes_val;
153 lifetimes_val.resize(n1);
154 for (int i1 = 0; i1 < n1; ++i1) {
155 int elem;
156 {
157 int elem_in = cyclus::Query<int>(sub, "val", i1);
158 elem = elem_in;
159 }
160 lifetimes_val[i1] = elem;
161 }
162 lifetimes = lifetimes_val;
163 }
164 } else {
165 std::vector< int > lifetimes_tmp;
166 lifetimes_tmp.resize(0);
167 {
168 }
169 lifetimes = lifetimes_tmp;
170 }
171 if (sub->NMatches("latitude") > 0) {
172 {
173 double latitude_val = cyclus::Query<double>(sub, "latitude");
174 latitude = latitude_val;
175 }
176 } else {
177 double latitude_tmp = 0.0;
178 latitude = latitude_tmp;
179 }
180 if (sub->NMatches("longitude") > 0) {
181 {
182 double longitude_val = cyclus::Query<double>(sub, "longitude");
183 longitude = longitude_val;
184 }
185 } else {
186 double longitude_tmp = 0.0;
187 longitude = longitude_tmp;
188 }
189 di.NewDatum("Info")
190 ->AddVal("prototypes", prototypes, &cycpp_shape_prototypes)
191 ->AddVal("build_times", build_times, &cycpp_shape_build_times)
192 ->AddVal("n_build", n_build, &cycpp_shape_n_build)
193 ->AddVal("lifetimes", lifetimes, &cycpp_shape_lifetimes)
194 ->AddVal("latitude", latitude, &cycpp_shape_latitude)
195 ->AddVal("longitude", longitude, &cycpp_shape_longitude)
196 ->Record();
197 };
198
199 virtual cyclus::Agent* Clone() {
200 cycamore::DeployInst* m = new cycamore::DeployInst(context());
201 m->InitFrom(this);
202 return m;
203 };
204
205 virtual std::string schema() {
206 return ""
207 "<interleave>\n"
208 " <element name=\"prototypes\">\n"
209 " <oneOrMore>\n"
210 " <element name=\"val\">\n"
211 " <data type=\"string\"/>\n"
212 " </element>\n"
213 " </oneOrMore>\n"
214 " </element>\n"
215 " <element name=\"build_times\">\n"
216 " <oneOrMore>\n"
217 " <element name=\"val\">\n"
218 " <data type=\"int\"/>\n"
219 " </element>\n"
220 " </oneOrMore>\n"
221 " </element>\n"
222 " <element name=\"n_build\">\n"
223 " <oneOrMore>\n"
224 " <element name=\"val\">\n"
225 " <data type=\"int\"/>\n"
226 " </element>\n"
227 " </oneOrMore>\n"
228 " </element>\n"
229 " <optional>\n"
230 " <element name=\"lifetimes\">\n"
231 " <oneOrMore>\n"
232 " <element name=\"val\">\n"
233 " <data type=\"int\"/>\n"
234 " </element>\n"
235 " </oneOrMore>\n"
236 " </element>\n"
237 " </optional>\n"
238 " <optional>\n"
239 " <element name=\"latitude\">\n"
240 " <a:documentation>Latitude of the agent's geographical position. The value should be expressed in degrees as a double.</a:documentation>\n"
241 " <data type=\"double\"/>\n"
242 " </element>\n"
243 " </optional>\n"
244 " <optional>\n"
245 " <element name=\"longitude\">\n"
246 " <a:documentation>Longitude of the agent's geographical position. The value should be expressed in degrees as a double.</a:documentation>\n"
247 " <data type=\"double\"/>\n"
248 " </element>\n"
249 " </optional>\n"
250 "</interleave>\n";
251 };
252
253 virtual Json::Value annotations() {
254 Json::Value root;
255 Json::Reader reader;
256 bool parsed_ok = reader.parse(
257 "{\"name\":\"cycamore::DeployInst\",\"entity\":\"instituti"
258 "on\",\"parents\":[\"cyclus::Institution\",\"cyclus::tool"
259 "kit::CommodityProducerManager\",\"cyclus::toolkit::P"
260 "osition\"],\"all_parents\":[\"EconomicEntity\",\"cyclus:"
261 ":Agent\",\"cyclus::Ider\",\"cyclus::Institution\",\"cycl"
262 "us::StateWrangler\",\"cyclus::TimeListener\",\"cyclus:"
263 ":toolkit::AgentManaged\",\"cyclus::toolkit::Commodit"
264 "yProducerManager\",\"cyclus::toolkit::Position\"],\"va"
265 "rs\":{\"prototypes\":{\"doc\":\"Ordered list of "
266 "prototypes to build.\",\"uitype\":[\"oneormore\",\"proto"
267 "type\"],\"uilabel\":[\"Prototypes to deploy\",\"\"],\"type"
268 "\":[\"std::vector\",\"std::string\"],\"index\":0,\"shape\":"
269 "[-1,-"
270 "1],\"alias\":[\"prototypes\",\"val\"],\"tooltip\":[\"protot"
271 "ypes\",\"\"]},\"build_times\":{\"doc\":\"Time step on "
272 "which to deploy agents given in prototype list "
273 "(same order).\",\"uilabel\":[\"Deployment times\",\"\"],\""
274 "type\":[\"std::vector\",\"int\"],\"index\":1,\"shape\":[-"
275 "1,-"
276 "1],\"alias\":[\"build_times\",\"val\"],\"tooltip\":[\"build"
277 "_times\",\"\"]},\"n_build\":{\"doc\":\"Number of each "
278 "prototype given in prototype list that should be "
279 "deployed (same order).\",\"uilabel\":[\"Number to depl"
280 "oy\",\"\"],\"type\":[\"std::vector\",\"int\"],\"index\":2,\"sh"
281 "ape\":[-1,-"
282 "1],\"alias\":[\"n_build\",\"val\"],\"tooltip\":[\"n_build\","
283 "\"\"]},\"lifetimes\":{\"doc\":\"Lifetimes for each "
284 "prototype in prototype list (same order). These "
285 "lifetimes override the lifetimes in the original "
286 "prototype definition. If unspecified, lifetimes "
287 "from the original prototype definitions are used. "
288 "Although a new prototype is created in the "
289 "Prototypes table for each lifetime with the suffix"
290 " '_life_[lifetime]', all deployed agents "
291 "themselves will have the same original prototype "
292 "name (and so will the Agents tables).\",\"default\":["
293 "],\"uilabel\":[\"Lifetimes\",\"\"],\"type\":[\"std::vector\""
294 ",\"int\"],\"index\":3,\"shape\":[-1,-"
295 "1],\"alias\":[\"lifetimes\",\"val\"],\"tooltip\":[\"lifetim"
296 "es\",\"\"]},\"latitude\":{\"default\":0.0,\"uilabel\":\"Geog"
297 "raphical latitude in degrees as a "
298 "double\",\"doc\":\"Latitude of the agent's "
299 "geographical position. The value should be "
300 "expressed in degrees as a double.\",\"type\":\"double\""
301 ",\"index\":4,\"shape\":[-"
302 "1],\"alias\":\"latitude\",\"tooltip\":\"latitude\"},\"longi"
303 "tude\":{\"default\":0.0,\"uilabel\":\"Geographical "
304 "longitude in degrees as a double\",\"doc\":\"Longitude"
305 " of the agent's geographical position. The value "
306 "should be expressed in degrees as a double.\",\"type"
307 "\":\"double\",\"index\":5,\"shape\":[-"
308 "1],\"alias\":\"longitude\",\"tooltip\":\"longitude\"}},\"do"
309 "c\":\"Builds and manages agents (facilities) "
310 "according to a manually specified deployment "
311 "schedule. Deployed agents are automatically "
312 "decommissioned at the end of their lifetime. "
313 "Deployed and decommissioned agents are registered "
314 "and unregistered with a region. The user specifies"
315 " a list of prototypes for each and corresponding "
316 "build times, number to build, and (optionally) "
317 "lifetimes. The same prototype can be specified "
318 "multiple times with any combination of the same or"
319 " different build times, build number, and "
320 "lifetimes. \"}", root);
321 if (!parsed_ok) {
322 throw cyclus::ValueError("failed to parse annotations for cycamore::DeployInst.");
323 }
324 return root;
325 };
326
327 virtual void InitInv(cyclus::Inventories& inv) {
328 };
329
330 virtual cyclus::Inventories SnapshotInv() {
331 cyclus::Inventories invs;
332 return invs;
333 };
334
335 virtual void Snapshot(cyclus::DbInit di) {
336 di.NewDatum("Info")
337 ->AddVal("prototypes", prototypes, &cycpp_shape_prototypes)
338 ->AddVal("build_times", build_times, &cycpp_shape_build_times)
339 ->AddVal("n_build", n_build, &cycpp_shape_n_build)
340 ->AddVal("lifetimes", lifetimes, &cycpp_shape_lifetimes)
341 ->AddVal("latitude", latitude, &cycpp_shape_latitude)
342 ->AddVal("longitude", longitude, &cycpp_shape_longitude)
343 ->Record();
344 };
345#line 46 "/cycamore/src/deploy_inst.h"
346
347 virtual void Build(cyclus::Agent* parent);
348
349 virtual void EnterNotify();
350
351 virtual void BuildNotify(Agent* m);
352 virtual void DecomNotify(Agent* m);
355 void WriteProducerInformation(cyclus::toolkit::CommodityProducer*
356 producer);
357
358 private:
360 void Register_(cyclus::Agent* agent);
361
363 void Unregister_(cyclus::Agent* agent);
364
365 protected:
366 #pragma cyclus var { "doc": "Ordered list of prototypes to build.", "uitype": ("oneormore", "prototype"), "uilabel": "Prototypes to deploy", }
367#line 71 "/cycamore/src/deploy_inst.h"
368 std::vector<std::string> prototypes;
369 std::vector<int> cycpp_shape_prototypes;
370#line 86 "/cycamore/src/deploy_inst.h"
371
372
373 #pragma cyclus var { "doc": "Time step on which to deploy agents given in prototype list " "(same order).", "uilabel": "Deployment times", }
374 std::vector<int> build_times;
375 std::vector<int> cycpp_shape_build_times;
376
377
378 #pragma cyclus var { "doc": "Number of each prototype given in prototype list that should be " "deployed (same order).", "uilabel": "Number to deploy", }
379 std::vector<int> n_build;
380 std::vector<int> cycpp_shape_n_build;
381
382
383
384 #pragma cyclus var { "doc": "Lifetimes for each prototype in prototype list (same order)." " These lifetimes override the lifetimes in the original prototype" " definition." " If unspecified, lifetimes from the original prototype definitions" " are used." " Although a new prototype is created in the Prototypes table for" " each lifetime with the suffix '_life_[lifetime]'," " all deployed agents themselves will have the same original" " prototype name (and so will the Agents tables).", "default": [], "uilabel": "Lifetimes" }
385#line 101 "/cycamore/src/deploy_inst.h"
386 std::vector<int> lifetimes;
387 std::vector<int> cycpp_shape_lifetimes;
388
389#line 102 "/cycamore/src/deploy_inst.h"
390
391 private:
392 // Code Injection:
393 #include "toolkit/position.cycpp.h"
394
395};
396
397} // namespace cycamore
398
399#endif // CYCAMORE_SRC_DEPLOY_INST_H_
cycamore_version.h
CYCAMORE_VERSION
#define CYCAMORE_VERSION
Definition build/cycamore/cycamore_version.h:7
cycamore::DeployInst::WriteProducerInformation
void WriteProducerInformation(cyclus::toolkit::CommodityProducer *producer)
write information about a commodity producer to a stream
Definition build/cycamore/deploy_inst.cc:101
cycamore::DeployInst::Unregister_
void Unregister_(cyclus::Agent *agent)
unregister a child
cycamore::DeployInst::SnapshotInv
virtual cyclus::Inventories SnapshotInv()
Definition build/cycamore/deploy_inst.h:330
cycamore::DeployInst::cycpp_shape_lifetimes
std::vector< int > cycpp_shape_lifetimes
Definition build/cycamore/deploy_inst.h:387
cycamore::DeployInst::annotations
virtual Json::Value annotations()
Definition build/cycamore/deploy_inst.h:253
cycamore::DeployInst::cycpp_shape_n_build
std::vector< int > cycpp_shape_n_build
Definition build/cycamore/deploy_inst.h:380
cycamore::DeployInst::cycpp_shape_build_times
std::vector< int > cycpp_shape_build_times
Definition build/cycamore/deploy_inst.h:375
cycamore::DeployInst::DeployInst
DeployInst(cyclus::Context *ctx)
Definition build/cycamore/deploy_inst.cc:7
cycamore::DeployInst::DecomNotify
virtual void DecomNotify(Agent *m)
Definition build/cycamore/deploy_inst.cc:74
cycamore::DeployInst::Register_
void Register_(cyclus::Agent *agent)
register a child
cycamore::DeployInst::version
virtual std::string version()
Definition build/cycamore/deploy_inst.h:35
cycamore::DeployInst::Build
virtual void Build(cyclus::Agent *parent)
Definition build/cycamore/deploy_inst.cc:12
cycamore::DeployInst::InfileToDb
virtual void InfileToDb(cyclus::InfileTree *tree, cyclus::DbInit di)
Definition build/cycamore/deploy_inst.h:82
cycamore::DeployInst::cycpp_shape_prototypes
std::vector< int > cycpp_shape_prototypes
Definition build/cycamore/deploy_inst.h:369
cycamore::DeployInst::InitFrom
virtual void InitFrom(cycamore::DeployInst *m)
Definition build/cycamore/deploy_inst.h:36
cycamore::DeployInst::Clone
virtual cyclus::Agent * Clone()
Definition build/cycamore/deploy_inst.h:199
cycamore::DeployInst::prototypes
std::vector< std::string > prototypes
Definition build/cycamore/deploy_inst.h:368
cycamore::DeployInst::Snapshot
virtual void Snapshot(cyclus::DbInit di)
Definition build/cycamore/deploy_inst.h:335
cycamore::DeployInst::InitInv
virtual void InitInv(cyclus::Inventories &inv)
Definition build/cycamore/deploy_inst.h:327
cycamore::DeployInst::BuildNotify
virtual void BuildNotify(Agent *m)
Definition build/cycamore/deploy_inst.cc:70
cycamore::DeployInst::InitFrom
virtual void InitFrom(cyclus::QueryableBackend *b)
Definition build/cycamore/deploy_inst.h:59
cycamore::BuildSched
std::map< int, std::vector< std::string > > BuildSched
Definition build/cycamore/deploy_inst.h:15