File: Signaller.h

package info (click to toggle)
ausaxs 1.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 72,592 kB
  • sloc: cpp: 49,853; ansic: 6,901; python: 730; makefile: 18
file content (42 lines) | stat: -rw-r--r-- 1,280 bytes parent folder | download
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
// SPDX-License-Identifier: LGPL-3.0-or-later
// Author: Kristian Lytje

#pragma once

#include <cstddef>

namespace ausaxs::signaller {
    /**
     * @brief A small probe for signalling changes which can be dispatched to other classes. 
     */
    class Signaller {
        public: 
            Signaller() = default;
            virtual ~Signaller() = default;

            /**
             * @brief Signal that the external state (i.e. position, rotation) of this object has changed. 
             */
            virtual void modified_external() const = 0;

            /**
             * @brief Signal that the internal state (removed or added atoms) of this object has changed.
             */
            virtual void modified_internal() const = 0;

            /**
             * @brief Signal that the ith symmetry of this object has changed. 
             */
            virtual void modified_symmetry(int i) const = 0;

            /**
             * @brief Signal that the hydration layer of this object has changed. 
             */
            virtual void modified_hydration() const = 0;

            /**
             * @brief Set the number of symmetries to track. 
             */
            virtual void set_symmetry_size(std::size_t size) const = 0;
    };
}