File syscParameter.h

Location: syscParameter.h

Classes

• SyscParameter

Includes

• SystemCouplingParticipant/LibraryType.hpp
• SystemCouplingParticipant/syscCommonTypes.h
• <stddef.h>

graph LR
1["syscParameter.h"]
click 1 "syscParameter_8h.md#syscParameter_8h"
1 --> 2
1 --> 3
1 --> 4

3["SystemCouplingParticipant/syscCommonTypes.h"]

4["stddef.h"]

2["SystemCouplingParticipant/LibraryType.hpp"]

Typedefs

Typedef SyscParameter

Definition: syscParameter.h (line 29)

typedef struct SyscParameter SyscParameter

Provide a struct for a System Coupling parameter.

Return type: struct SyscParameter

Functions

Function syscGetParameter

SyscParameter syscGetParameter(const char *name)

Create parameter to be used in a coupled analysis.

Parameters:

• name: - Unique name for this parameter. String length should not exceed SYSC_STRING_LENGTH.

Display name will default to the same as name.

Parameters:

• const char * name

Return type: SyscParameter

Function syscGetParameterD

SyscParameter syscGetParameterD(const char *name, const char *displayName)

Create parameter to be used in a coupled analysis.

Parameters:

• name: - Unique name for this parameter. String length should not exceed SYSC_STRING_LENGTH.
• displayName: - parameter display name. String length should not exceed SYSC_STRING_LENGTH.

Parameters:

• const char * name
• const char * displayName

Return type: SyscParameter

Source

/*
* Copyright ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
*/

#pragma once

#include "SystemCouplingParticipant/LibraryType.hpp"

#include "SystemCouplingParticipant/syscCommonTypes.h"

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct SyscParameter {
  char name[SYSC_STRING_LENGTH];        
  char displayName[SYSC_STRING_LENGTH]; 
} SyscParameter;

 SyscParameter syscGetParameter(
  const char* name);

 SyscParameter syscGetParameterD(
  const char* name,
  const char* displayName);

#ifdef __cplusplus
}
#endif