Loading...
Searching...
No Matches
Job.h
Go to the documentation of this file.
1/*
2** This file is part of eOn.
3**
4** SPDX-License-Identifier: BSD-3-Clause
5**
6** Copyright (c) 2010--present, eOn Development Team
7** All rights reserved.
8**
9** Repo:
10** https://github.com/TheochemUI/eOn
11*/
12#pragma once
13#include "Parameters.h"
14#include "Potential.h"
15#include "Runtime.h"
16#include <memory>
17#include <stdexcept>
18#include <string>
19#include <utility>
20#include <vector>
21
22namespace eonc {
23
33
48
52
53class Job {
54private:
55protected:
56 // make const
60 std::unique_ptr<Runtime> owned_runtime_;
64 std::unique_ptr<Potential> ownedPot;
66 std::shared_ptr<Potential> pot;
67
70
71 Job(std::unique_ptr<Parameters> parameters, Runtime &rt, ExclusivePotential)
72 : jtype{parameters->main_options().job}, params{*std::move(parameters)},
74 ownedPot{helpers::makePotential(params.potential_options().potential,
75 params, rt)} {}
76
77public:
79 void adoptRuntime(std::unique_ptr<Runtime> rt) {
80 if (!rt || runtime_ != rt.get()) {
81 throw std::logic_error(
82 "Job::adoptRuntime: Runtime is not the borrowed instance");
83 }
84 owned_runtime_ = std::move(rt);
85 }
86
89 Job(std::unique_ptr<Parameters> parameters, Runtime &rt)
90 : Job(std::move(parameters), rt, ExclusivePotential{}) {
92 }
93
94 Job(std::unique_ptr<Parameters> parameters, std::unique_ptr<Runtime> rt)
95 : Job(std::move(parameters), *rt) {
96 adoptRuntime(std::move(rt));
97 }
98
99 explicit Job(std::unique_ptr<Parameters> parameters)
100 : Job(std::move(parameters), std::make_unique<Runtime>()) {}
101 Job(std::shared_ptr<Potential> potPassed, const Parameters &parameters)
102 : jtype{parameters.main_options().job}, params{parameters},
103 owned_runtime_{std::make_unique<Runtime>()},
104 runtime_{owned_runtime_.get()}, pot{std::move(potPassed)} {}
105 virtual ~Job() = default;
107 virtual std::vector<std::string> run() = 0;
108 [[nodiscard]] JobType getType() { return this->jtype; };
109 [[nodiscard]] PotRegistry &pots() noexcept { return runtime_->pots(); }
112 [[nodiscard]] size_t potRegistryForceCalls() const noexcept;
114 void releasePotential() { pot.reset(); }
115};
116
117namespace helpers {
119std::unique_ptr<Job> makeJob(std::unique_ptr<Parameters> params);
121std::unique_ptr<Job> makeJob(std::unique_ptr<Parameters> params,
122 Runtime &runtime);
124std::unique_ptr<Job> makeJob(std::unique_ptr<Parameters> params,
125 Runtime &&runtime);
127std::unique_ptr<Job> makeJob(std::unique_ptr<Parameters> params,
128 std::unique_ptr<Runtime> runtime);
129} // namespace helpers
130
131} // namespace eonc
PotRegistry & pots() noexcept
Definition Job.h:109
Job(std::unique_ptr< Parameters > parameters, Runtime &rt)
Borrow: caller keeps Runtime alive (CLI stack / Python Session).
Definition Job.h:89
void adoptRuntime(std::unique_ptr< Runtime > rt)
Take ownership of a Runtime previously passed as Runtime&.
Definition Job.h:79
Job(std::unique_ptr< Parameters > parameters, std::unique_ptr< Runtime > rt)
Own a Runtime (one-shot makeJob / rvalue).
Definition Job.h:94
size_t potRegistryForceCalls() const noexcept
Force calls charged to pot's registry.
Definition Job.cpp:44
Job(std::unique_ptr< Parameters > parameters, Runtime &rt, ExclusivePotential)
Definition Job.h:71
virtual ~Job()=default
Job(std::unique_ptr< Parameters > parameters)
Own a default-constructed Runtime.
Definition Job.h:99
JobType getType()
Definition Job.h:108
std::unique_ptr< Runtime > owned_runtime_
Non-null when this Job owns the composition root (one-shot makeJob).
Definition Job.h:60
Job(std::shared_ptr< Potential > potPassed, const Parameters &parameters)
Definition Job.h:101
JobType jtype
Definition Job.h:57
std::shared_ptr< Potential > pot
Set when one Potential is shared across Matters, images, or a caller.
Definition Job.h:66
Parameters params
Definition Job.h:58
virtual std::vector< std::string > run()=0
Virtual run; used solely for dynamic dispatch.
void releasePotential()
Drop the Potential so on_destroyed is recorded before Runtime dies.
Definition Job.h:114
Runtime * runtime_
Always valid: either owned_runtime_.get() or a caller-owned Runtime.
Definition Job.h:62
std::unique_ptr< Potential > ownedPot
Exclusive until a multi-owner job promotes it in the public constructor.
Definition Job.h:64
Move-only composition root for process resources (dlopen loaders and the potential registry).
Definition Runtime.h:27
std::shared_ptr< Potential > sharePotential(std::unique_ptr< Potential > pot)
Multi-owner boundary: one instance observed by several Matters, images, or a binding.
Definition Potential.h:292
std::unique_ptr< Job > makeJob(std::unique_ptr< Parameters > params, Runtime &runtime)
Borrow: caller keeps Runtime alive.
RAII resource manager for the ARTn C library with global synchronization.
Point and Minimization keep ownedPot. Other jobs share in the public ctor.
Definition Job.h:69