Structure sysc::ParticipantInfo

Definition: CommonTypes.hpp (line 288)

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

Parameters:

• scHost: host name to connect to System Coupling
• scPort: port number to connect to System Coupling
• participantName: name of the participant
• isCosimulation: flag if the simulation is a cosimulation
• buildInformation: information for the current build
• transcriptFilename: the name of the transcript to be written to
• numApps: number of applications connected by SCP library
• myHostName: (optional) host name to use for remote server(s)

Members

• buildInformation
• isCosimulation
• myHostName
• numApps
• ParticipantInfo
• ParticipantInfo
• ParticipantInfo
• ParticipantInfo
• ParticipantInfo
• participantName
• scHost
• scPort
• transcriptFilename

Public attributes

Variable scHost

Definition: CommonTypes.hpp (line 289)

Host sysc::ParticipantInfo::scHost

Type: Host

Variable scPort

Definition: CommonTypes.hpp (line 290)

Port sysc::ParticipantInfo::scPort {0}

Type: Port

Variable participantName

Definition: CommonTypes.hpp (line 291)

std::string sysc::ParticipantInfo::participantName

Type: std::string

Variable isCosimulation

Definition: CommonTypes.hpp (line 292)

bool sysc::ParticipantInfo::isCosimulation {false}

Type: bool

Variable buildInformation

Definition: CommonTypes.hpp (line 293)

std::string sysc::ParticipantInfo::buildInformation

Type: std::string

Variable transcriptFilename

Definition: CommonTypes.hpp (line 294)

std::string sysc::ParticipantInfo::transcriptFilename

Type: std::string

Variable numApps

Definition: CommonTypes.hpp (line 296)

std::size_t sysc::ParticipantInfo::numApps {0}

Type: std::size_t

Variable myHostName

Definition: CommonTypes.hpp (line 297)

Host sysc::ParticipantInfo::myHostName

Type: Host

Public functions

Function ParticipantInfo

sysc::ParticipantInfo::ParticipantInfo()=default

Provide a default constructor.

Return type:

Function ParticipantInfo

sysc::ParticipantInfo::ParticipantInfo(Host scHost, Port scPort, std::string participantName, bool isCosimulation, std::string buildInformation, std::string transcriptFilename, std::size_t numApps, Host myHostName)

Provide a non-default constructor.

Parameters:

• Host scHost
• Port scPort
• std::string participantName
• bool isCosimulation
• std::string buildInformation
• std::string transcriptFilename
• std::size_t numApps
• Host myHostName

Return type:

Function ParticipantInfo

sysc::ParticipantInfo::ParticipantInfo(Host scHost, Port scPort, std::string participantName)

Provide a non-default constructor.

Parameters:

• Host scHost
• Port scPort
• std::string participantName

Return type:

Function ParticipantInfo

sysc::ParticipantInfo::ParticipantInfo(Host scHost, Port scPort, std::string participantName, std::string buildInformation)

Provide a non-default constructor.

Parameters:

• Host scHost
• Port scPort
• std::string participantName
• std::string buildInformation

Return type:

Function ParticipantInfo

sysc::ParticipantInfo::ParticipantInfo(Host scHost, Port scPort, std::string participantName, std::string buildInformation, std::string transcriptFilename)

Provide a non-default constructor.

Parameters:

• Host scHost
• Port scPort
• std::string participantName
• std::string buildInformation
• std::string transcriptFilename

Return type: