## On this page

  

 

 # SyscSetupInfo Struct Reference

 Last update: 17.07.2025 

Provide a structure for System Coupling setup information. [More...](structSyscSetupInfo.xhtml#details)

`#include <<a class="el" href="syscCommonTypes_8h_source.xhtml">syscCommonTypes.h</a>>`

## <a id="pub-attribs" name="pub-attribs"></a>Data Fields

enum [SyscAnalysisType](group__SyscParticipantLibraryCAPI.xhtml#ga7d5b3786948265c902f7231abe6d79b5) [analysisType](structSyscSetupInfo.xhtml#ac769cbb25b2b34dbb5bc44f281299780) int [restartsSupported](structSyscSetupInfo.xhtml#a50a3305a3b93fedcc8f4435bd43b9aa1) enum [SyscDimension](group__SyscParticipantLibraryCAPI.xhtml#gac5a5f66ee72fd8015eab632a642cf26d) [dimension](structSyscSetupInfo.xhtml#a8f4b32e8360553ac5bb5d179efb58b81) <a id="details" name="details"></a>## Detailed Description

Provide a structure for System Coupling setup information.

To create and/or initialize the [SyscSetupInfo](structSyscSetupInfo.xhtml "Provide a structure for System Coupling setup information.") struct, it is highly recommended to use one of the functions with names starting with `syscGetSetupInfo`. These functions will initialize all members to the correct values and will help to avoid back-compatibility issues in the future. For example:

[SyscSetupInfo](structSyscSetupInfo.xhtml) setupInfo = [syscGetSetupInfoA](group__SyscParticipantLibraryCAPI.xhtml#gae399cbc645966a48cc2928bb51018d9b)([SyscSteady](group__SyscParticipantLibraryCAPI.xhtml#gga7d5b3786948265c902f7231abe6d79b5ad0d53c33e61857fdfe41e2501eebc8dd)); 

[syscGetSetupInfoA](group__SyscParticipantLibraryCAPI.xhtml#gae399cbc645966a48cc2928bb51018d9b)

SyscSetupInfo syscGetSetupInfoA(enum SyscAnalysisType analysisType)

Create a setup info struct.



[SyscSteady](group__SyscParticipantLibraryCAPI.xhtml#gga7d5b3786948265c902f7231abe6d79b5ad0d53c33e61857fdfe41e2501eebc8dd)

@ SyscSteady

**Definition** [syscCommonTypes.h:113](syscCommonTypes_8h_source.xhtml#l00113)



[SyscSetupInfo](structSyscSetupInfo.xhtml)

Provide a structure for System Coupling setup information.

**Definition** [syscCommonTypes.h:166](syscCommonTypes_8h_source.xhtml#l00166)





Definition at line [166](syscCommonTypes_8h_source.xhtml#l00166) of file [syscCommonTypes.h](syscCommonTypes_8h_source.xhtml).



## Field Documentation

<a id="ac769cbb25b2b34dbb5bc44f281299780" name="ac769cbb25b2b34dbb5bc44f281299780"></a>## [◆ ](#ac769cbb25b2b34dbb5bc44f281299780)analysisType

 enum [SyscAnalysisType](group__SyscParticipantLibraryCAPI.xhtml#ga7d5b3786948265c902f7231abe6d79b5) SyscSetupInfo::analysisType

Analysis type.

Definition at line [167](syscCommonTypes_8h_source.xhtml#l00167) of file [syscCommonTypes.h](syscCommonTypes_8h_source.xhtml).





<a id="a8f4b32e8360553ac5bb5d179efb58b81" name="a8f4b32e8360553ac5bb5d179efb58b81"></a>## [◆ ](#a8f4b32e8360553ac5bb5d179efb58b81)dimension

 enum [SyscDimension](group__SyscParticipantLibraryCAPI.xhtml#gac5a5f66ee72fd8015eab632a642cf26d) SyscSetupInfo::dimension

Participant dimension.

Definition at line [169](syscCommonTypes_8h_source.xhtml#l00169) of file [syscCommonTypes.h](syscCommonTypes_8h_source.xhtml).





<a id="a50a3305a3b93fedcc8f4435bd43b9aa1" name="a50a3305a3b93fedcc8f4435bd43b9aa1"></a>## [◆ ](#a50a3305a3b93fedcc8f4435bd43b9aa1)restartsSupported

 int SyscSetupInfo::restartsSupported

Flag indicating whether restarts are supported.

Definition at line [168](syscCommonTypes_8h_source.xhtml#l00168) of file [syscCommonTypes.h](syscCommonTypes_8h_source.xhtml).