Skip to main content

System Coupling Participant library 2025 R2

File syscDataTransfer.h

Last update: 17.07.2025

Location: syscDataTransfer.h

Classes

Includes

  • SystemCouplingParticipant/LibraryType.hpp
  • SystemCouplingParticipant/syscCommonTypes.h
  • SystemCouplingParticipant/syscVariable.h
  • <stddef.h>
graph LR
3["SystemCouplingParticipant/syscCommonTypes.h"]

5["stddef.h"]

2["SystemCouplingParticipant/LibraryType.hpp"]

4["SystemCouplingParticipant/syscVariable.h"]

1["syscDataTransfer.h"]
click 1 "syscDataTransfer_8h.md#syscDataTransfer_8h"
1 --> 2
1 --> 3
1 --> 4
1 --> 5

Typedefs

Typedef SyscDataTransfer

Definition: syscDataTransfer.h (line 33)

typedef struct SyscDataTransfer SyscDataTransfer

Provide a struct for a data transfer.

Data transfer specifies the source and target variables for mapping.

Return type: struct SyscDataTransfer

Functions

Function syscGetDataTransfer

SyscDataTransfer syscGetDataTransfer(SyscVariable sideOneVariable, SyscVariable sideTwoVariable, enum SyscInterfaceSide targetSide)

Create a data transfer using side{One|Two}Variable.

Parameters:

  • sideOneVariable: - side one variable.
  • sideTwoVariable: - side two variable.
  • targetSide: - target side.

Parameters:

Return type: SyscDataTransfer

Function syscGetDataTransferST

SyscDataTransfer syscGetDataTransferST(SyscVariable sourceVariable, SyscVariable targetVariable, enum SyscInterfaceSide targetSide)

Create a data transfer using {source|target}Variable.

Parameters:

  • sourceVariable: - source variable.
  • targetVariable: - target variable.
  • targetSide: - target side.

Parameters:

Return type: SyscDataTransfer

Source

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

#pragma once

#include "SystemCouplingParticipant/LibraryType.hpp"

#include "SystemCouplingParticipant/syscCommonTypes.h"
#include "SystemCouplingParticipant/syscVariable.h"

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct SyscDataTransfer {
  SyscVariable sourceVariable;
  SyscVariable targetVariable;
  enum SyscInterfaceSide targetSide;
} SyscDataTransfer;

SyscDataTransfer syscGetDataTransfer(
  SyscVariable sideOneVariable,
  SyscVariable sideTwoVariable,
  enum SyscInterfaceSide targetSide);

SyscDataTransfer syscGetDataTransferST(
  SyscVariable sourceVariable,
  SyscVariable targetVariable,
  enum SyscInterfaceSide targetSide);

#ifdef __cplusplus
}
#endif

Connect with Ansys