paramsInfo.h

// Copyright 2009-2025 NTESS. Under the terms
// of Contract DE-NA0003525 with NTESS, the U.S.
// Government retains certain rights in this software.
//
// Copyright (c) 2009-2025, NTESS
// All rights reserved.
//
// This file is part of the SST software package. For license
// information, see the LICENSE file in the top level directory of the
// distribution.
 
#ifndef SST_CORE_ELI_PARAMS_INFO_H
#define SST_CORE_ELI_PARAMS_INFO_H
 
#include "sst/core/eli/elibase.h"
 
#include <string>
#include <vector>
 
namespace SST::ELI {
 
template <typename, typename = void>
struct GetParams
{
    static const std::vector<SST::ElementInfoParam>& get()
    {
        static std::vector<SST::ElementInfoParam> var = {};
        return var;
    }
};
 
template <class T>
struct GetParams<T, std::void_t<decltype(T::ELI_getParams())>>
{
    static const std::vector<SST::ElementInfoParam>& get() { return T::ELI_getParams(); }
};
 
class ProvidesParams
{
public:
    const std::vector<ElementInfoParam>& getValidParams() const { return params_; }
 
    void toString(std::ostream& os) const;
 
    template <class XMLNode>
    void outputXML(XMLNode* node) const
    {
        // Build the Element to Represent the Component
        int idx = 0;
        for ( const ElementInfoParam& param : params_ ) {
            ;
            // Build the Element to Represent the Parameter
            auto* XMLParameterElement = new XMLNode("Parameter");
            XMLParameterElement->SetAttribute("Index", idx);
            XMLParameterElement->SetAttribute("Name", param.name);
            XMLParameterElement->SetAttribute("Description", param.description ? param.description : "none");
            XMLParameterElement->SetAttribute("Default", param.defaultValue ? param.defaultValue : "none");
            node->LinkEndChild(XMLParameterElement);
            ++idx;
        }
    }
 
    const std::vector<std::string>& getParamNames() const { return allowedKeys; }
 
protected:
    template <class T>
    explicit ProvidesParams(T* UNUSED(t)) :
        params_(GetParams<T>::get())
    {
        init();
    }
 
private:
    void init();
 
    std::vector<std::string>      allowedKeys;
    std::vector<ElementInfoParam> params_;
};
 
} // namespace SST::ELI
 
// clang-format off
#define SST_ELI_DOCUMENT_PARAMS(...)                                                                           \
    static const std::vector<SST::ElementInfoParam>& ELI_getParams()                                           \
    {                                                                                                          \
        static std::vector<SST::ElementInfoParam> var    = { __VA_ARGS__ };                                    \
        auto parent = SST::ELI::GetParams<                                                                     \
            std::conditional_t<(__EliDerivedLevel > __EliBaseLevel), __LocalEliBase, __ParentEliBase>>::get(); \
        SST::ELI::combineEliInfo(var, parent);                                                                 \
        return var;                                                                                            \
    }
// clang-format on
 
#define SST_ELI_DELETE_PARAM(param) { param, nullptr, nullptr }
 
#endif // SST_CORE_ELI_PARAMS_INFO_H