File: StateManager.h

package info (click to toggle)
ausaxs 1.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 72,592 kB
  • sloc: cpp: 49,853; ansic: 6,901; python: 730; makefile: 18
file content (122 lines) | stat: -rw-r--r-- 3,671 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// SPDX-License-Identifier: LGPL-3.0-or-later
// Author: Kristian Lytje

#pragma once

#include <data/state/DataStateFwd.h>

#include <vector>
#include <memory>

namespace ausaxs::state {
	/**
	 * @brief A state manager which keeps track of changes in each body. 
	 *        This is meant to be used in conjunction with DistanceCalculator, such that it only recalculates what is absolutely necessary. 
	 */
	class StateManager {
		public:
			StateManager(std::size_t size);

			/**
			 * @brief Mark that all atoms of all bodies were internally modified. 
			 */
			void internally_modified_all();

			/**
			 * @brief Mark that all atoms of all bodies were externally modified. 
			 */
			void externally_modified_all();

			/**
			 * @brief Mark that all atoms of the ith body were internally modified.
			 */
			void internally_modified(int i);

			/**
			 * @brief Mark that all atoms of the ith body were externally modified.
			 */
			void externally_modified(int i);

			/**
			 * @brief Mark that the hydration layer was modified.
			 */
			void modified_hydration_layer();

			/**
			 * @brief Mark that the jth symmetry of the ith body was modified.
			 */
			void modified_symmetry(int i, int j);

			/**
			 * @brief Reset all marks to false.
			 * ? The awkard name is to avoid accidental collisions with the reset method of smart pointers. 
			 */
			void reset_to_false();

			/**
			 * @brief Get a pointer to the @a ith probe so it can be dispatched to other classes.
			 */
			std::shared_ptr<signaller::Signaller> get_probe(int i);

			/**
			 * @brief Set the @a ith probe.
			 */
			void set_probe(int i, std::shared_ptr<signaller::Signaller> probe);

			/**
			 * @brief Get a pointer to all probes.
			 */
			std::vector<std::shared_ptr<signaller::Signaller>> get_probes();

			/**
			 * @brief Get a boolean vector which denotes if the external state of a given body was changed. 
			 */
			const std::vector<bool>& get_externally_modified_bodies() const;
			std::vector<bool>& get_externally_modified_bodies(); //< @copydoc get_externally_modified_bodies

			/**
			 * @brief Get a boolean vector which denotes if the internal state of a given body was changed. 
			 */
			const std::vector<bool>& get_internally_modified_bodies() const;
			std::vector<bool>& get_internally_modified_bodies(); //< @copydoc get_internally_modified_bodies

			/**
			 * @brief Get a boolean vector which denotes if the symmetry of a given body was changed. 
			 */
			const std::vector<std::vector<bool>>& get_symmetry_modified_bodies() const;
			std::vector<std::vector<bool>>& get_symmetry_modified_bodies(); //< @copydoc get_symmetry_modified_bodies

			/**
			 * @brief Check if a given body has been marked as modified.
			 */
			[[nodiscard]] bool is_externally_modified(int i) const;

			/**
			 * @brief Check if a given body has been marked as modified.
			 */
			[[nodiscard]] bool is_internally_modified(int i) const;

			/**
			 * @brief Returns true if the jth symmetry of the ith body has been modified, false otherwise. 
			 */
			[[nodiscard]] bool is_modified_symmetry(int i, int j) const;

			/**
			 * @brief Returns true if the hydration layer has been modified, false otherwise. 
			 */
			[[nodiscard]] bool is_modified_hydration() const;

			/**
			 * @brief Get the number of bodies being managed. 
			 */
			[[nodiscard]] std::size_t size() const;

		private:
			std::size_t 					_size;
			std::vector<bool> 				_externally_modified;
			std::vector<bool> 				_internally_modified;
			std::vector<std::vector<bool>> 	_symmetry_modified;
			bool 							_modified_hydration;
			std::vector<std::shared_ptr<signaller::Signaller>> probes;
	};
}