Skip to main content

SST_ELI_REGISTER_MODULE

SST_ELI_REGISTER_MODULE(class_name, "library", "name", 
    SST_ELI_ELEMENT_VERSION(major, minorX, minorY), "description", api_class_name)

All modules must register themselves with SST using this macro. The library and name strings provided in this macro will be used by SST to identify the module as "library.name". The version and description are displayed by sst-info to document the version and purpose of the Module. The api_class_name field is used to enable ELI inheritance.

Important

This macro must reside in a public section of the Module's header file.

Parameters​

  • class_name (class) The name of the Module class. This is not a string.
  • library (string) The name of the library that this Module belongs to. If the library name does not exist, it will be created.
  • name (string) The name that will be used to instantiate this Module in the simulation input configuration. It can be the same as the class_name but does not need to be. The full name of the Module will be library.name.
  • SST_ELI_ELEMENT_VERSION(major, minorX, minorY) This is a macro that specifies the version of a Module. major, minorX, and minorY are integers that form a version number major.minorX.minorY. For example: SST_ELI_ELEMENT_VERSION(3, 0, 9) yields a version of 3.0.9. Versions are not checked by SST, this is provided for developers to version and manage their libraries.
  • description (string) A description of the module
  • api_class_name (class) The fully qualified name of the module's API class. This is not a string.
info

library and name must follow SST's element naming conventions.

Example​

Registering a Module​

In this example, AModuleAPI is a Module API class. AnActualModule is an SST Module that inherits from AModuleAPI and inherits its ELI parameter as well.

#include <sst/core/module.h>

namespace SST {
class AModuleAPI : public SST::Module
{
public:
    SST_ELI_REGISTER_MODULE_API(SST::AModuleAPI)

    SST_ELI_DOCUMENT_PARAMS(
        { "count", "The count of something", 20 }
    )

    /* Rest of class here */
};

class AnActualModule : public SST::AModuleAPI
{
public:

    SST_ELI_REGISTER_MODULE(
        AnActualModule,                 // Module class
        "exampleLibrary",               // Library name, the 'lib' in SST's lib.name format
        "mymodule",                     // // Name used to refer to this module, the 'name' in SST's lib.name format
        SST_ELI_ELEMENT_VERSION(1,0,0), // A version number
        "Example of ELI inheritance",   // Description
        SST::AModuleAPI                 // Module API
    )
    
    SST_ELI_DOCUMENT_PARAMS(
      { "name", "A name for this module" }
    )

    /* The module 'exampleLibrary.mymodule' will have two parameters: 'count' and 'name' */

/* Rest of class */
};
} /* End namespace SST */
#include <sst/core/module.h>