SST  7.0.0
StructuralSimulationToolkit
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:
SST::Module SST::BaseComponent SST::Interfaces::SimpleMem SST::Interfaces::SimpleNetwork SST::Interfaces::SimpleNetwork::NetworkInspector

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.
 
LinkconfigureLink (std::string name, TimeConverter *time_base, Event::HandlerBase *handler=NULL)
 Configure a Link. More...
 
LinkconfigureLink (std::string name, std::string time_base, Event::HandlerBase *handler=NULL)
 Configure a Link. More...
 
LinkconfigureLink (std::string name, Event::HandlerBase *handler=NULL)
 Configure a Link. More...
 
LinkconfigureSelfLink (std::string name, TimeConverter *time_base, Event::HandlerBase *handler=NULL)
 Configure a SelfLink (Loopback link) More...
 
LinkconfigureSelfLink (std::string name, std::string time_base, Event::HandlerBase *handler=NULL)
 Configure a SelfLink (Loopback link) More...
 
LinkconfigureSelfLink (std::string name, Event::HandlerBase *handler=NULL)
 Configure a SelfLink (Loopback link) More...
 
TimeConverterregisterClock (std::string freq, Clock::HandlerBase *handler, bool regAll=true)
 Registers a clock for this component. More...
 
TimeConverterregisterClock (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.
 
TimeConverterregisterOneShot (std::string timeDelay, OneShot::HandlerBase *handler)
 Registers a OneShot event for this component. More...
 
TimeConverterregisterOneShot (const UnitAlgebra &timeDelay, OneShot::HandlerBase *handler)
 
TimeConverterregisterTimeBase (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...
 
TimeConvertergetTimeConverter (const std::string &base)
 
TimeConvertergetTimeConverter (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="")
 
ModuleloadModule (std::string type, Params &params)
 Loads a module from an element Library. More...
 
ModuleloadModuleWithComponent (std::string type, Component *comp, Params &params)
 Loads a module from an element Library. More...
 
SubComponentloadSubComponent (std::string type, Component *comp, Params &params)
 Loads a SubComponent from an element Library. More...
 
SubComponentloadNamedSubComponent (std::string name)
 
SubComponentloadNamedSubComponent (std::string name, Params &params)
 
SubComponentSlotInfogetSubComponentSlotInfo (std::string name, bool fatalOnEmptyIndex=false)
 
const std::vector< double > & getCoordinates () const
 Retrieve the X,Y,Z coordinates of this component.
 

Protected Member Functions

ComponentgetTrueComponent () const final override
 
BaseComponentgetStatisticOwner () const final override
 Returns self if Component If sub-component, returns self if a "modern" subcomponent otherwise, return base component.
 
SubComponentloadSubComponent (std::string type, Params &params)
 
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.
 
LinkselfLink (std::string name, Event::HandlerBase *handler=NULL)
 Creates a new selfLink.
 
SharedRegiongetLocalSharedRegion (const std::string &key, size_t size)
 Find a lookup table.
 
SharedRegiongetGlobalSharedRegion (const std::string &key, size_t size, SharedRegionMerger *merger=NULL)
 
SimulationgetSimulation () 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
TimeConverterdefaultTimeBase
 Timebase used if no other timebase is specified for calls like BaseComponent::getCurrentSimTime(). More...
 
ComponentInfomy_info
 
Simulationsim
 
ComponentInfocurrentlyLoadingSubComponent
 

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

virtual void SST::SubComponent::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.

virtual void SST::SubComponent::init ( unsigned int   UNUSEDphase)
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.

virtual void SST::SubComponent::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

friend class 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: