SST  11.1.0
StructuralSimulationToolkit
subcomponent.h
1 // Copyright 2009-2021 NTESS. Under the terms
2 // of Contract DE-NA0003525 with NTESS, the U.S.
3 // Government retains certain rights in this software.
4 //
5 // Copyright (c) 2009-2021, NTESS
6 // All rights reserved.
7 //
8 // This file is part of the SST software package. For license
9 // information, see the LICENSE file in the top level directory of the
10 // distribution.
11 
12 #ifndef SST_CORE_SUBCOMPONENT_H
13 #define SST_CORE_SUBCOMPONENT_H
14 
15 #include "sst/core/baseComponent.h"
16 #include "sst/core/eli/elementinfo.h"
17 #include "sst/core/module.h"
18 #include "sst/core/warnmacros.h"
19 
20 namespace SST {
21 
22 /**
23  SubComponent is a class loadable through the factory which allows
24  dynamic functionality to be added to a Component. The
25  SubComponent API is nearly identical to the Component API and all
26  the calls are proxied to the parent Component.
27 */
28 class SubComponent : public Module, public BaseComponent
29 {
30 
31 public:
32  SST_ELI_DECLARE_BASE(SubComponent)
33  // declare extern to limit compile times
34  SST_ELI_DECLARE_CTOR_EXTERN(ComponentId_t)
35  SST_ELI_DECLARE_INFO_EXTERN(
41 
42  SubComponent(ComponentId_t id);
43 
44  virtual ~SubComponent() {};
45 
46  /** Used during the init phase. The method will be called each phase of initialization.
47  Initialization ends when no components have sent any data. */
48  virtual void init(unsigned int UNUSED(phase)) override {}
49  /** Called after all components have been constructed and initialization has
50  completed, but before simulation time has begun. */
51  virtual void setup() override {}
52  /** Called after simulation completes, but before objects are
53  destroyed. A good place to print out statistics. */
54  virtual void finish() override {}
55 
56 private:
57  friend class Component;
58 };
59 
60 } // namespace SST
61 
62 // New way to register subcomponents. Must register an interface
63 // (API) first, then you can register a subcomponent that implements
64 // it
65 #define SST_ELI_REGISTER_SUBCOMPONENT_API(cls, ...) \
66  SST_ELI_DECLARE_NEW_BASE(SST::SubComponent,::cls) \
67  SST_ELI_NEW_BASE_CTOR(SST::ComponentId_t,SST::Params&,##__VA_ARGS__)
68 
69 #define SST_ELI_REGISTER_SUBCOMPONENT_DERIVED_API(cls, base, ...) \
70  SST_ELI_DECLARE_NEW_BASE(::base,::cls) \
71  SST_ELI_NEW_BASE_CTOR(SST::ComponentId_t,SST::Params&,##__VA_ARGS__)
72 
73 #define SST_ELI_REGISTER_SUBCOMPONENT_DERIVED(cls, lib, name, version, desc, interface) \
74  SST_ELI_REGISTER_DERIVED(::interface,cls,lib,name,ELI_FORWARD_AS_ONE(version),desc) \
75  SST_ELI_INTERFACE_INFO(#interface)
76 
77 #endif // SST_CORE_SUBCOMPONENT_H
virtual void finish() override
Called after simulation completes, but before objects are destroyed.
Definition: subcomponent.h:54
Definition: portsInfo.h:39
Main component object for the simulation.
Definition: component.h:30
Definition: statsInfo.h:39
Module is a tag class used with the loadModule function.
Definition: module.h:21
Definition: paramsInfo.h:40
virtual void setup() override
Called after all components have been constructed and initialization has completed, but before simulation time has begun.
Definition: subcomponent.h:51
Main component object for the simulation.
Definition: baseComponent.h:51
Definition: subcompSlotInfo.h:39
virtual void init(unsigned int UNUSED(phase)) override
Used during the init phase.
Definition: subcomponent.h:48
SubComponent is a class loadable through the factory which allows dynamic functionality to be added t...
Definition: subcomponent.h:28
Definition: interfaceInfo.h:18