System Coupling C++ library 2024 R1

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 (std::string scHost, unsigned short scPort, std::string participantName)
 Provide a non-default constructor.
 
 ParticipantInfo (std::string scHost, unsigned short scPort, std::string participantName, std::string buildInformation)
 Provide a non-default constructor.
 
 ParticipantInfo (std::string scHost, unsigned short scPort, std::string participantName, std::string buildInformation, std::string transcriptFilename)
 Provide a non-default constructor.
 

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 239 of file CommonTypes.hpp.

Constructor & Destructor Documentation

◆ ParticipantInfo() [1/3]

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

Provide a non-default constructor.

Definition at line 251 of file CommonTypes.hpp.

254 :
255 scHost(std::move(scHost)),
256 scPort(scPort),
257 participantName(std::move(participantName)),
258 isCosimulation(true)
259 {
260 }

◆ ParticipantInfo() [2/3]

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

Provide a non-default constructor.

Definition at line 263 of file CommonTypes.hpp.

267 :
268 scHost(std::move(scHost)),
269 scPort(scPort),
270 participantName(std::move(participantName)),
271 isCosimulation(true),
272 buildInformation(std::move(buildInformation))
273 {
274 }

◆ ParticipantInfo() [3/3]

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

Provide a non-default constructor.

Definition at line 277 of file CommonTypes.hpp.

282 :
283 scHost(std::move(scHost)),
284 scPort(scPort),
285 participantName(std::move(participantName)),
286 isCosimulation(true),
287 buildInformation(std::move(buildInformation)),
288 transcriptFilename(std::move(transcriptFilename))
289 {
290 }

Member Data Documentation

◆ buildInformation

std::string sysc::ParticipantInfo::buildInformation

Definition at line 244 of file CommonTypes.hpp.

◆ isCosimulation

bool sysc::ParticipantInfo::isCosimulation {false}

Definition at line 243 of file CommonTypes.hpp.

243{false};

◆ participantName

std::string sysc::ParticipantInfo::participantName

Definition at line 242 of file CommonTypes.hpp.

◆ scHost

std::string sysc::ParticipantInfo::scHost

Definition at line 240 of file CommonTypes.hpp.

◆ scPort

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

Definition at line 241 of file CommonTypes.hpp.

241{0};

◆ transcriptFilename

std::string sysc::ParticipantInfo::transcriptFilename

Definition at line 245 of file CommonTypes.hpp.

Connect with Ansys