Hedgehog  0.0.0
A library to generate hybrid pipeline workflow systems
core_slot.h
1 // NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the
2 // software in any medium, provided that you keep intact this entire notice. You may improve, modify and create
3 // derivative works of the software or any portion of the software, and you may copy and distribute such modifications
4 // or works. Modified works should carry a notice stating that you changed the software and should note the date and
5 // nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the
6 // source of the software. NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND,
7 // EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
8 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
9 // WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE
10 // CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS
11 // THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE. You
12 // are solely responsible for determining the appropriateness of using and distributing the software and you assume
13 // all risks associated with its use, including but not limited to the risks and costs of program errors, compliance
14 // with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of
15 // operation. This software is not intended to be used in any situation where a failure could cause risk of injury or
16 // damage to property. The software developed by NIST employees is not subject to copyright protection within the
17 // United States.
18 
19 
20 #ifndef HEDGEHOG_CORE_SLOT_H
21 #define HEDGEHOG_CORE_SLOT_H
22 
23 #include "../../../node/core_node.h"
24 
26 namespace hh::core {
27 
28 #ifndef DOXYGEN_SHOULD_SKIP_THIS
29 class CoreNotifier;
31 #endif //DOXYGEN_SHOULD_SKIP_THIS
32 
34 class CoreSlot : public virtual CoreNode {
35  public:
36 
41  CoreSlot(std::string_view const &name, NodeType const type, size_t const numberThreads) :
42  CoreNode(name, type, numberThreads) {
43  HLOG_SELF(0, "Creating CoreSlot with type: " << (int) type << " and name: " << name)
44  }
45 
47  ~CoreSlot() override {HLOG_SELF(0, "Destructing CoreSlot")}
48 
51  virtual void addNotifier(CoreNotifier *notifier) = 0;
52 
55  virtual void removeNotifier(CoreNotifier *notifier) = 0;
56 
59  virtual bool hasNotifierConnected() = 0;
60 
63  [[nodiscard]] virtual size_t numberInputNodes() const = 0;
64 
66  virtual void wakeUp() = 0;
67 
70  virtual bool waitForNotification() = 0;
71 };
72 
73 }
74 #endif //HEDGEHOG_CORE_SLOT_H
NodeType type() const
Node type accessor.
Definition: core_node.h:132
Core Notifier interface, emit notification to CoreSlot.
Definition: core_notifier.h:34
virtual void wakeUp()=0
Interface to define what the node do when it receive a signal.
~CoreSlot() override
Core Slot destructor.
Definition: core_slot.h:47
virtual bool hasNotifierConnected()=0
Test if notifiers are connected to this slot.
Slot interface, receive notification from CoreNotifier.
Definition: core_slot.h:34
virtual void removeNotifier(CoreNotifier *notifier)=0
Interface to remove a CoreNotifier from this slot.
NodeType
Hedgehog node&#39;s type.
Definition: core_node.h:40
Main Hedgehog core abstraction.
Definition: core_node.h:48
Hedgehog core namespace.
Definition: core_execute.h:25
std::string_view const & name() const
Node name accessor.
Definition: core_node.h:128
virtual void addNotifier(CoreNotifier *notifier)=0
Interface to add a CoreNotifier to this slot.
CoreSlot(std::string_view const &name, NodeType const type, size_t const numberThreads)
Core slot constructor.
Definition: core_slot.h:41
virtual size_t numberInputNodes() const =0
Return the number of notifiers connected to this slot.
size_t numberThreads() const
Number of threads associated accessor.
Definition: core_node.h:152
virtual bool waitForNotification()=0
Interface to define how the node wait for a signal, and return if the node is terminated.