SST::CoreTestComponent::coreTestComponentBase Class Reference
Inheritance diagram for SST::CoreTestComponent::coreTestComponentBase:
Public Member Functions | |
| SST_ELI_DOCUMENT_PARAMS ({ "workPerCycle", "Count of busy work to do during a clock tick.", NULL}, { "clockFrequency", "Frequency of the clock", "1GHz"}) SST_ELI_DOCUMENT_STATISTICS( | |
| SST_ELI_DOCUMENT_PORTS ({"Nlink", "Link to the coreTestComponent to the North", { "coreTestComponent.coreTestComponentEvent", "" } }) SST_ELI_DOCUMENT_ATTRIBUTES( | |
| coreTestComponentBase (ComponentId_t id) | |
| void | serialize_order (SST::Core::Serialization::serializer &ser) override |
| Public Member Functions inherited from SST::Component | |
| SST_ELI_DECLARE_INFO_EXTERN (ELI::ProvidesCategory, ELI::ProvidesParams, ELI::ProvidesPorts, ELI::ProvidesSubComponentSlots, ELI::ProvidesStats, ELI::ProvidesCheckpointable, ELI::ProvidesProfilePoints, ELI::ProvidesAttributes) explicit Component(ComponentId_t id) | |
| Constructor. | |
| Public Member Functions inherited from SST::BaseComponent | |
| BaseComponent (ComponentId_t id) | |
| BaseComponent (const BaseComponent &)=delete | |
| BaseComponent & | operator= (const BaseComponent &)=delete |
| const std::string & | getType () const |
| Gets the ELI type for this BaseComponent. | |
| ComponentId_t | getId () const |
| Get the unique component ID. | |
| uint8_t | getStatisticLoadLevel () const |
| Get the BaseComponent Statistic load level. | |
| virtual void | emergencyShutdown () |
| Called when SIGINT or SIGTERM has been seen. | |
| const std::string & | getName () const |
| Get the name of the BaseComponent. | |
| const std::string & | getParentComponentName () const |
| Get the name of the parent Component for the Component tree. | |
| virtual void | init (unsigned int UNUSED(phase)) |
| Used during the init phase. | |
| virtual void | complete (unsigned int UNUSED(phase)) |
| Used during the complete phase after the end of simulation. | |
| virtual void | setup () |
| Called after all components have been constructed and initialization has completed, but before simulation time has begun. | |
| virtual void | finish () |
| Called after complete phase, but before objects are destroyed. | |
| virtual bool | Status () |
| Currently unused function. | |
| virtual void | printStatus (Output &UNUSED(out)) |
| Called by the Simulation to request that the component print its current status. | |
| UnitAlgebra | getCoreTimeBase () const |
| Get the core timebase. | |
| SimTime_t | getCurrentSimCycle () const |
| Get the current simulation time as a cycle count. | |
| int | getCurrentPriority () const |
| Get the current priority. | |
| UnitAlgebra | getElapsedSimTime () const |
| get the elapsed simulation time as a UnitAlgebra | |
| SimTime_t | getEndSimCycle () const |
| Get the end simulation time as a cycle count. | |
| UnitAlgebra | getEndSimTime () const |
| Get the end simulation time as a UnitAlgebra. | |
| RankInfo | getRank () const |
| Get this instance's parallel rank. | |
| RankInfo | getNumRanks () const |
| Get the number of parallel ranks in the simulation. | |
| SimTime_t | getCurrentSimTime () const |
| Return the simulated time since the simulation began in the default timebase. | |
| SimTime_t | getCurrentSimTime (TimeConverter base) const |
| Get the simulated time since the simulation began in units specified by the parameter. | |
| SimTime_t | getCurrentSimTime (const std::string &base) const |
| Return the simulated time since the simulation began in the specified timebase. | |
| SimTime_t | getCurrentSimTime (const char *base) const |
| Return the simulated time since the simulation began in the specified timebase. | |
| 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. | |
| double | getRunPhaseElapsedRealTime () const |
| Get the amount of real-time spent executing the run phase of the simulation. | |
| double | getInitPhaseElapsedRealTime () const |
| Get the amount of real-time spent executing the init phase of the simulation. | |
| double | getCompletePhaseElapsedRealTime () const |
| Get the amount of real-time spent executing the complete phase of the simulation. | |
| void | addWatchPoint (WatchPoint *pt) |
| Add a watch point to all handlers in the Component Tree. | |
| void | removeWatchPoint (WatchPoint *pt) |
| Remove a watch point from all handlers in the Component Tree. | |
| SubComponentSlotInfo * | getSubComponentSlotInfo (const std::string &name, bool fatalOnEmptyIndex=false) |
| const std::vector< double > & | getCoordinates () const |
| Retrieve the X,Y,Z coordinates of this component. | |
| Public Member Functions inherited from SST::Core::Serialization::serializable_base | |
| virtual const char * | cls_name () const =0 |
| virtual uint32_t | cls_id () const =0 |
| virtual std::string | serialization_name () const =0 |
Additional Inherited Members | |
| Static Public Member Functions inherited from SST::BaseComponent | |
| static Output & | getSimulationOutput () |
| Get the default simulation Output class instance. | |
| Static Public Attributes inherited from SST::Core::Serialization::serializable_base | |
| static constexpr uint32_t | NullClsId = std::numeric_limits<uint32_t>::max() |
| Protected Types inherited from SST::BaseComponent | |
| using | StatCreateFunction |
| Protected Types inherited from SST::Core::Serialization::serializable_base | |
| enum | cxn_flag_t { ConstructorFlag } |
| Protected Member Functions inherited from SST::BaseComponent | |
| bool | isSimulationRunModeInit () const |
| Check to see if the run mode was set to INIT. | |
| bool | isSimulationRunModeRun () const |
| Check to see if the run mode was set to RUN. | |
| bool | isSimulationRunModeBoth () const |
| Check to see if the run mode was set to BOTH. | |
| std::string & | getOutputDirectory () const |
| Returns the output directory of the simulation. | |
| void | requireLibrary (const std::string &name) |
| Signifies that a library is required for this simulation. | |
| bool | isPortConnected (const std::string &name) const |
| Determine if a port name is connected to any links. | |
| Link * | configureLink (const std::string &name, TimeConverter timebase, Event::HandlerBase *handler=nullptr) |
| Configure a Link. | |
| Link * | configureLink (const std::string &name, Event::HandlerBase *handler=nullptr) |
| Configure a Link. | |
| Link * | configureSelfLink (const std::string &name, TimeConverter timebase, Event::HandlerBase *handler=nullptr) |
| Configure a SelfLink (Loopback link). | |
| Link * | configureSelfLink (const std::string &name, Event::HandlerBase *handler=nullptr) |
| Configure a SelfLink (Loopback link) that uses the (Sub)Component's defaultTimeBase. | |
| TimeConverter | registerClock (TimeConverter tc, Clock::HandlerBase *handler, bool reg_all=true) |
| Registers a clock for this component. | |
| 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. | |
| Cycle_t | getNextClockCycle (TimeConverter freq) |
| Returns the next Cycle that the TimeConverter would fire. | |
| TimeConverter | registerTimeBase (const std::string &base, bool reg_all=true) |
| Registers a default timebase for the component and optionally sets the the component's links to that timebase. | |
| TimeConverter | getTimeConverter (const std::string &base) const |
| TimeConverter | getTimeConverter (const UnitAlgebra &base) const |
| bool | isStatisticShared (const std::string &stat_name, bool include_me=false) |
| void | initiateInteractive (const std::string &msg) |
| Tell the simulation object to initiate interactive mode (if currently turned on). | |
| template<typename T> | |
| Statistics::Statistic< T > * | registerStatistic (SST::Params ¶ms, const std::string &stat_name, const std::string &stat_sub_id="") |
| Registers a statistic. | |
| template<typename T> | |
| Statistics::Statistic< T > * | registerStatistic (const std::string &stat_name, const std::string &stat_sub_id="") |
| template<typename... Args> | |
| Statistics::Statistic< std::tuple< Args... > > * | registerMultiStatistic (const std::string &stat_name, const std::string &stat_sub_id="") |
| template<typename... Args> | |
| Statistics::Statistic< std::tuple< Args... > > * | registerMultiStatistic (SST::Params ¶ms, const std::string &stat_name, const std::string &stat_sub_id="") |
| template<typename T> | |
| Statistics::Statistic< T > * | registerStatistic (const char *stat_name, const char *stat_sub_id="") |
| void | performStatisticOutput (Statistics::StatisticBase *stat) |
| Called by the Components and Subcomponent to perform a statistic Output. | |
| void | performGlobalStatisticOutput () |
| Performs a global statistic Output. | |
| template<typename T> | |
| T::ProfilePoint * | registerProfilePoint (const std::string &point_name) |
| Registers a profiling point. | |
| template<class T, class... ARGS> | |
| T * | loadModule (const std::string &type, Params ¶ms, ARGS... args) |
| Loads a module from an element Library. | |
| template<class T, class... ARGS> | |
| T * | loadComponentExtension (ARGS... args) |
| template<class T> | |
| bool | isSubComponentLoadableUsingAPI (const std::string &type) |
| Check to see if a given element type is loadable with a particular API. | |
| template<class T> | |
| bool | isUserSubComponentLoadableUsingAPI (const std::string &slot_name) |
| Check to see if the element type loaded by the user into the. | |
| template<class T, class... ARGS> | |
| T * | loadAnonymousSubComponent (const std::string &type, const std::string &slot_name, int slot_num, uint64_t share_flags, Params ¶ms, ARGS... args) |
| Loads an anonymous subcomponent (not defined in input file to SST run). | |
| template<class T> | |
| T * | loadUserSubComponent (const std::string &slot_name) |
| Loads a user defined subcomponent (defined in input file to SST run). | |
| template<class T, class... ARGS> | |
| T * | loadUserSubComponent (const std::string &slot_name, uint64_t share_flags, ARGS... args) |
| Loads a user defined subcomponent (defined in input file to SST run). | |
| void | fatal (uint32_t line, const char *file, const char *func, int exit_code, const char *format,...) const |
| Convenience function for reporting fatal conditions. | |
| void | sst_assert (bool condition, uint32_t line, const char *file, const char *func, int exit_code, const char *format,...) const |
| Convenience function for testing for and reporting fatal conditions. | |
| bool | isAnonymous () |
| bool | isUser () |
| void | setDefaultTimeBase (TimeConverter tc) |
| Manually set the default defaultTimeBase. | |
| TimeConverter | getDefaultTimeBase () |
| const TimeConverter | getDefaultTimeBase () const |
| bool | doesSubComponentExist (const std::string &type) |
| uint8_t | getStatisticValidityAndLevel (const std::string &statisticName) const |
| std::vector< Profile::ComponentProfileTool * > | getComponentProfileTools (const std::string &point) |
| void | registerAsPrimaryComponent () |
| Register as a primary component, which allows the component to specify when it is and is not OK to end simulation. | |
| void | primaryComponentDoNotEndSim () |
| Tells the simulation that it should not exit. | |
| void | primaryComponentOKToEndSim () |
| Tells the simulation that it is now OK to end simulation. | |
| Static Protected Member Functions inherited from SST::Core::Serialization::serializable_base | |
| static void | serializable_abort (uint32_t line, const char *file, const char *func, const char *obj) |
Member Function Documentation
◆ serialize_order()
|
inlineoverridevirtual |
Reimplemented from SST::Component.
The documentation for this class was generated from the following file:
- src/sst/core/testElements/coreTest_Component.h
