FederateInfo.hpp

/*
Copyright (c) 2017-2026,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Energy
Innovation LLC.  See the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once
#include "../core/CoreFederateInfo.hpp"
#include "../core/CoreTypes.hpp"
#include "helics_cxx_export.h"
 
#include <memory>
#include <string>
#include <vector>
 
namespace CLI {
class App;
}
 
namespace helics {
class helicsCLI11App;
 
namespace fileops {
    class JsonBuffer;
}
class HELICS_CXX_EXPORT FederateInfo: public CoreFederateInfo {
  public:
    int uniqueKey{0};  
    char separator{'/'};  
    bool autobroker{
        false};  
    bool debugging{false};
    bool observer{false};
    CoreType coreType{CoreType::DEFAULT};  
    int brokerPort{-1};  
 
    bool forceNewCore{false};  
    bool useJsonSerialization{false};
    bool encrypted{false};
    std::string profilerFileName;
    std::string encryptionConfig;  
    std::string defName;  
    std::string coreName;  
    std::string coreInitString;  
    std::string brokerInitString;  
    std::string broker;  
    std::string key;  
    std::string localport;  
 
    std::string configString;  
    bool fileInUse{false};
    FederateInfo();
    explicit FederateInfo(CoreType cType);
    explicit FederateInfo(const std::string& args);
    FederateInfo(int argc, char* argv[]);
    explicit FederateInfo(std::vector<std::string>& args);
    std::vector<std::string> loadInfoFromArgs(const std::string& args);
    std::vector<std::string> loadInfoFromArgs(int argc, char* argv[]);
    void loadInfoFromArgs(std::vector<std::string>& args);
    void loadInfoFromArgsIgnoreOutput(const std::string& args);
    void loadInfoFromArgsIgnoreOutput(int argc, char* argv[]);
 
    void loadInfoFromToml(const std::string& toml, bool runArgParser = true);
 
    void loadInfoFromJson(const std::string& json, bool runArgParser = true);
 
    Time checkTimeProperty(int propId, Time defVal) const;
    bool checkFlagProperty(int propId, bool defVal) const;
    int checkIntProperty(int propId, int defVal) const;
 
    void injectParser(CLI::App* app);
 
  private:
    std::unique_ptr<helicsCLI11App> makeCLIApp();
    void config_additional(CLI::App* app);
    void loadJsonConfig(const fileops::JsonBuffer& json);
};
 
HELICS_CXX_EXPORT FederateInfo loadFederateInfo(const std::string& configString);
 
HELICS_CXX_EXPORT std::string generateFullCoreInitString(const FederateInfo& fedInfo);
 
HELICS_CXX_EXPORT int getPropertyIndex(std::string val);
 
HELICS_CXX_EXPORT int getFlagIndex(std::string val);
 
HELICS_CXX_EXPORT int getOptionIndex(std::string val);
 
HELICS_CXX_EXPORT int getOptionValue(std::string val);
 
}  // namespace helics