SST::SubComponent Class Reference
SubComponent is a class loadable through the factory which allows dynamic functionality to be added to a Component. More...
#include <subcomponent.h>
Inheritance diagram for SST::SubComponent:
Public Member Functions | |
| SubComponent (Component *parent) | |
| virtual void | init (unsigned int UNUSED(phase)) override |
| Used during the init phase. More... | |
| virtual void | setup () override |
| Called after all components have been constructed and inialization has completed, but before simulation time has begun. More... | |
| virtual void | finish () override |
| Called after simulation completes, but before objects are destroyed. More... | |
 Public Member Functions inherited from SST::BaseComponent | |
| ComponentId_t | getId () const |
| Returns unique component ID. | |
| virtual void | emergencyShutdown (void) |
| Called when SIGINT or SIGTERM has been seen. More... | |
| const std::string & | getName () const |
| Returns component Name. | |
| virtual bool | Status () |
| Currently unused function. | |
| virtual void | printStatus (Output &UNUSED(out)) |
| Called by the Simulation to request that the component print it's current status. More... | |
| bool | isPortConnected (const std::string &name) const |
| Determine if a port name is connected to any links. | |
| Link * | configureLink (std::string name, TimeConverter *time_base, Event::HandlerBase *handler=NULL) |
| Configure a Link. More... | |
| Link * | configureLink (std::string name, std::string time_base, Event::HandlerBase *handler=NULL) |
| Configure a Link. More... | |
| Link * | configureLink (std::string name, Event::HandlerBase *handler=NULL) |
| Configure a Link. More... | |
| Link * | configureSelfLink (std::string name, TimeConverter *time_base, Event::HandlerBase *handler=NULL) |
| Configure a SelfLink (Loopback link) More... | |
| Link * | configureSelfLink (std::string name, std::string time_base, Event::HandlerBase *handler=NULL) |
| Configure a SelfLink (Loopback link) More... | |
| Link * | configureSelfLink (std::string name, Event::HandlerBase *handler=NULL) |
| Configure a SelfLink (Loopback link) More... | |
| TimeConverter * | registerClock (std::string freq, Clock::HandlerBase *handler, bool regAll=true) |
| Registers a clock for this component. More... | |
| TimeConverter * | registerClock (const UnitAlgebra &freq, Clock::HandlerBase *handler, bool regAll=true) |
| void | unregisterClock (TimeConverter *tc, Clock::HandlerBase *handler) |
| Removes a clock handler from the component. | |
| Cycle_t | reregisterClock (TimeConverter *freq, Clock::HandlerBase *handler) |
| Reactivates an existing Clock and Handler. More... | |
| Cycle_t | getNextClockCycle (TimeConverter *freq) |
| Returns the next Cycle that the TimeConverter would fire. | |
| TimeConverter * | registerOneShot (std::string timeDelay, OneShot::HandlerBase *handler) |
| Registers a OneShot event for this component. More... | |
| TimeConverter * | registerOneShot (const UnitAlgebra &timeDelay, OneShot::HandlerBase *handler) |
| TimeConverter * | registerTimeBase (std::string base, bool regAll=true) |
| Registers a default time base for the component and optionally sets the the component's links to that timebase. More... | |
| TimeConverter * | getTimeConverter (const std::string &base) |
| TimeConverter * | getTimeConverter (const UnitAlgebra &base) |
| SimTime_t | getCurrentSimTime (TimeConverter *tc) const |
| return the time since the simulation began in units specified by the parameter. More... | |
| SimTime_t | getCurrentSimTime () const |
| return the time since the simulation began in the default timebase | |
| SimTime_t | getCurrentSimTime (std::string base) |
| return the time since the simulation began in timebase specified More... | |
| SimTime_t | getCurrentSimTimeNano () const |
| Utility function to return the time since the simulation began in nanoseconds. | |
| SimTime_t | getCurrentSimTimeMicro () const |
| Utility function to return the time since the simulation began in microseconds. | |
| SimTime_t | getCurrentSimTimeMilli () const |
| Utility function to return the time since the simulation began in milliseconds. | |
| template<typename T > | |
| Statistic< T > * | registerStatistic (std::string statName, std::string statSubId="") |
| Registers a statistic. More... | |
| template<typename T > | |
| Statistic< T > * | registerStatistic (const char *statName, const char *statSubId="") |
| Module * | loadModule (std::string type, Params ¶ms) |
| Loads a module from an element Library. More... | |
| Module * | loadModuleWithComponent (std::string type, Component *comp, Params ¶ms) |
| Loads a module from an element Library. More... | |
| SubComponent * | loadSubComponent (std::string type, Component *comp, Params ¶ms) |
| Loads a SubComponent from an element Library. More... | |
| SubComponent * | loadNamedSubComponent (std::string name) |
| SubComponent * | loadNamedSubComponent (std::string name, Params ¶ms) |
| SubComponentSlotInfo * | getSubComponentSlotInfo (std::string name, bool fatalOnEmptyIndex=false) |
| const std::vector< double > & | getCoordinates () const |
| Retrieve the X,Y,Z coordinates of this component. | |
Protected Member Functions | |
| Component * | getTrueComponent () const final override |
| BaseComponent * | getStatisticOwner () const final override |
| Returns self if Component If sub-component, returns self if a "modern" subcomponent otherwise, return base component. | |
| SubComponent * | loadSubComponent (std::string type, Params ¶ms) |
| virtual bool | doesComponentInfoStatisticExist (const std::string &statisticName) const final override |
| Protected Member Functions inherited from SST::BaseComponent | |
| void | setDefaultTimeBase (TimeConverter *tc) |
| Manually set the default detaulTimeBase. | |
| Link * | selfLink (std::string name, Event::HandlerBase *handler=NULL) |
| Creates a new selfLink. | |
| SharedRegion * | getLocalSharedRegion (const std::string &key, size_t size) |
| Find a lookup table. | |
| SharedRegion * | getGlobalSharedRegion (const std::string &key, size_t size, SharedRegionMerger *merger=NULL) |
| Simulation * | getSimulation () const |
| uint8_t | getComponentInfoStatisticEnableLevel (const std::string &statisticName) const |
| std::string | getComponentInfoStatisticUnits (const std::string &statisticName) const |
Protected Attributes | |
| Component *const | parent |
| Protected Attributes inherited from SST::BaseComponent | |
| TimeConverter * | defaultTimeBase |
| Timebase used if no other timebase is specified for calls like BaseComponent::getCurrentSimTime(). More... | |
| ComponentInfo * | my_info |
| Simulation * | sim |
| ComponentInfo * | currentlyLoadingSubComponent |
Friends | |
| class | Component |
| Component's type, set by the factory when the object is created. More... | |
Detailed Description
SubComponent is a class loadable through the factory which allows dynamic functionality to be added to a Component.
The SubComponent API is nearly identical to the Component API and all the calls are proxied to the parent Compoent.
Member Function Documentation
◆ finish()
|
inlineoverridevirtual |
Called after simulation completes, but before objects are destroyed.
A good place to print out statistics.
Reimplemented from SST::BaseComponent.
Reimplemented in SST::Interfaces::SimpleNetwork.
◆ init()
|
inlineoverridevirtual |
Used during the init phase.
The method will be called each phase of initialization. Initialization ends when no components have sent any data.
Reimplemented from SST::BaseComponent.
Reimplemented in SST::Interfaces::SimpleNetwork.
◆ setup()
|
inlineoverridevirtual |
Called after all components have been constructed and inialization has completed, but before simulation time has begun.
Reimplemented from SST::BaseComponent.
Reimplemented in SST::Interfaces::SimpleNetwork.
Friends And Related Function Documentation
◆ Component
|
friend |
Component's type, set by the factory when the object is created.
It is identical to the configuration string used to create the component. I.e. the XML "<component id="aFoo"><foo>..." would set component::type to "foo"
The documentation for this class was generated from the following files:
- src/sst/core/subcomponent.h
- src/sst/core/subcomponent.cc
