Structure sysc::SetupFileInfo
Last update: 09.03.2026
Definition: CommonTypes.hpp (line 153)
Provide a structure for writing System Coupling setup files.
Members
- initialInput
- restartsSupported
- SetupFileInfo
- SetupFileInfo
- SetupFileInfo
- SetupFileInfo
- setupFileName
Public attributes
Variable setupFileName
Definition: CommonTypes.hpp (line 154)
std::string sysc::SetupFileInfo::setupFileName
Setup file name.
Type: std::string
Referenced by:
Variable restartsSupported
Definition: CommonTypes.hpp (line 155)
bool sysc::SetupFileInfo::restartsSupported
Do not use.
Type: bool
Referenced by:
Variable initialInput
Definition: CommonTypes.hpp (line 156)
std::string sysc::SetupFileInfo::initialInput
Initial input file.
Type: std::string
Referenced by:
Public functions
Function SetupFileInfo
sysc::SetupFileInfo::SetupFileInfo()
Provide a default constructor for SetupFileInfo.
Setup file name will be set to empty string. Restarts supported flag will be set to false.
Return type:
References:
Function SetupFileInfo
sysc::SetupFileInfo::SetupFileInfo(std::string setupFileName)
Provide a non-default constructor for SetupFileInfo.
Parameters:
- setupFileName: Setup file name.
Restarts supported flag will be set to false.
Parameters:
- std::string setupFileName
Return type:
References:
Function SetupFileInfo
sysc::SetupFileInfo::SetupFileInfo(std::string setupFileName, bool restartsSupported)
Provide a non-default constructor for SetupFileInfo.
Parameters:
- setupFileName: Setup file name.
- restartsSupported: Flag indicating whether restarts are supported.
Parameters:
- std::string setupFileName
- bool restartsSupported
Return type:
References:
Function SetupFileInfo
sysc::SetupFileInfo::SetupFileInfo(std::string setupFileName, bool restartsSupported, std::string initialInput)
Provide a non-default constructor for SetupFileInfo.
Parameters:
- setupFileName: Setup file name.
- restartsSupported: Flag indicating whether restarts are supported.
- initialInput: Initial input file name. If the file name is empty, no InitialInput is written to scp file.
Parameters:
- std::string setupFileName
- bool restartsSupported
- std::string initialInput
Return type:
References: