System Coupling C++ library 2023 R2

sysc::ParticipantInfo Struct Reference

Last update: 17.07.2025

provide a structure for the participant information needed to connect to a System Coupling object More...

#include <CommonTypes.hpp>

Public Member Functions

 ParticipantInfo ()=default
 Provide a default constructor.
 
 ParticipantInfo (const ParticipantInfo &)=default
 Provide a copy-constructor.
 
 ParticipantInfo (ParticipantInfo &&)=default
 Provide a move-constructor.
 
ParticipantInfo & operator= (const ParticipantInfo &)=default
 Provide a copy-assign operator.
 
ParticipantInfo & operator= (ParticipantInfo &&)=default
 Provide a move-assign operator.
 
 ParticipantInfo (const std::string &scHost, unsigned short scPort, const std::string &participantName)
 Provide a non-default constructor. More...
 
 ParticipantInfo (const std::string &scHost, unsigned short scPort, const std::string &participantName, const std::string &buildInformation)
 Provide a non-default constructor. More...
 
 ParticipantInfo (const std::string &scHost, unsigned short scPort, const std::string &participantName, const std::string &buildInformation, const std::string &transcriptFilename)
 Provide a non-default constructor. More...
 

Public Attributes

std::string scHost
 
unsigned short scPort {0}
 
std::string participantName
 
bool isCosimulation {false}
 
std::string buildInformation
 
std::string transcriptFilename
 

Detailed Description

provide a structure for the participant information needed to connect to a System Coupling object

Parameters
scHosthost name to connect to System Coupling
scPortport number to connect to System Coupling
participantNamename of the participant
isCosimulationflag if the simulation is a cosimulation
buildInformationinformation for the current build
transcriptFilenamethe name of the transcript to be written to

Definition at line 249 of file CommonTypes.hpp.

Constructor & Destructor Documentation

◆ ParticipantInfo() [1/3]

sysc::ParticipantInfo::ParticipantInfo ( const std::string &  scHost,
unsigned short  scPort,
const std::string &  participantName 
)
inline

Provide a non-default constructor.

Definition at line 273 of file CommonTypes.hpp.

276 :
277 scHost(scHost),
278 scPort(scPort),
279 participantName(participantName),
280 isCosimulation(true)
281 {
282 }

◆ ParticipantInfo() [2/3]

sysc::ParticipantInfo::ParticipantInfo ( const std::string &  scHost,
unsigned short  scPort,
const std::string &  participantName,
const std::string &  buildInformation 
)
inline

Provide a non-default constructor.

Definition at line 285 of file CommonTypes.hpp.

289 :
290 scHost(scHost),
291 scPort(scPort),
292 participantName(participantName),
293 isCosimulation(true),
294 buildInformation(buildInformation)
295 {
296 }

◆ ParticipantInfo() [3/3]

sysc::ParticipantInfo::ParticipantInfo ( const std::string &  scHost,
unsigned short  scPort,
const std::string &  participantName,
const std::string &  buildInformation,
const std::string &  transcriptFilename 
)
inline

Provide a non-default constructor.

Definition at line 299 of file CommonTypes.hpp.

304 :
305 scHost(scHost),
306 scPort(scPort),
307 participantName(participantName),
308 isCosimulation(true),
309 buildInformation(buildInformation),
310 transcriptFilename(transcriptFilename)
311 {
312 }

Member Data Documentation

◆ buildInformation

std::string sysc::ParticipantInfo::buildInformation

Definition at line 254 of file CommonTypes.hpp.

◆ isCosimulation

bool sysc::ParticipantInfo::isCosimulation {false}

Definition at line 253 of file CommonTypes.hpp.

◆ participantName

std::string sysc::ParticipantInfo::participantName

Definition at line 252 of file CommonTypes.hpp.

◆ scHost

std::string sysc::ParticipantInfo::scHost

Definition at line 250 of file CommonTypes.hpp.

◆ scPort

unsigned short sysc::ParticipantInfo::scPort {0}

Definition at line 251 of file CommonTypes.hpp.

◆ transcriptFilename

std::string sysc::ParticipantInfo::transcriptFilename

Definition at line 255 of file CommonTypes.hpp.

Connect with Ansys