Skip to main content

System Coupling C++ library 2023 R2

sysc::SetupFileInfo Struct Reference

Last update: 17.07.2025

Provide a structure for writing System Coupling setup files. More...

#include <CommonTypes.hpp>

Public Member Functions

 SetupFileInfo ()
 Provide a default constructor for SetupFileInfo. More...
 
 SetupFileInfo (const std::string &setupFileName)
 Provide a non-default constructor for SetupFileInfo. More...
 
 SetupFileInfo (const std::string &setupFileName, bool restartsSupported)
 Provide a non-default constructor for SetupFileInfo. More...
 

Public Attributes

std::string setupFileName
 
bool restartsSupported
 

Detailed Description

Provide a structure for writing System Coupling setup files.

Definition at line 121 of file CommonTypes.hpp.

Constructor & Destructor Documentation

◆ SetupFileInfo() [1/3]

sysc::SetupFileInfo::SetupFileInfo ( )
inline

Provide a default constructor for SetupFileInfo.

Setup file name will be set to empty string. Restarts supported flag will be set to false.

Definition at line 130 of file CommonTypes.hpp.

130 :
131 restartsSupported(false){};

◆ SetupFileInfo() [2/3]

sysc::SetupFileInfo::SetupFileInfo ( const std::string &  setupFileName)
inline

Provide a non-default constructor for SetupFileInfo.

Parameters
[in]setupFileNameSetup file name.

Restarts supported flag will be set to false.

Definition at line 140 of file CommonTypes.hpp.

140 :
142 restartsSupported(false){};
std::string setupFileName

◆ SetupFileInfo() [3/3]

sysc::SetupFileInfo::SetupFileInfo ( const std::string &  setupFileName,
bool  restartsSupported 
)
inline

Provide a non-default constructor for SetupFileInfo.

Parameters
[in]setupFileNameSetup file name.
[in]restartsSupportedFlag indicating whether restarts are supported.

Definition at line 150 of file CommonTypes.hpp.

Member Data Documentation

◆ restartsSupported

bool sysc::SetupFileInfo::restartsSupported

Do not use.

Definition at line 123 of file CommonTypes.hpp.

◆ setupFileName

std::string sysc::SetupFileInfo::setupFileName

Setup file name.

Definition at line 122 of file CommonTypes.hpp.

Connect with Ansys