System Coupling Participant library 2025 R2

File syscOutputScalarData.h

Last update: 17.07.2025

Location: syscOutputScalarData.h

Classes

Includes

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

3["SystemCouplingParticipant/syscCommonTypes.h"]

4["stddef.h"]

2["SystemCouplingParticipant/LibraryType.hpp"]

1["syscOutputScalarData.h"]
click 1 "syscOutputScalarData_8h.md#syscOutputScalarData_8h"
1 --> 2
1 --> 3
1 --> 4
1 --> 5

Functions

Function syscGetOutputScalarData

SyscOutputScalarData syscGetOutputScalarData()

Create an output scalar data access struct.

Primitive type will default to double-precision. Data size will be set to zero. Data pointer will be set to null.

Return type: SyscOutputScalarData

Function syscGetOutputScalarDataDouble

SyscOutputScalarData syscGetOutputScalarDataDouble(const double *const data, size_t dataSize)

Create an output scalar data access struct.

Parameters:

  • data: - pointer to the double-precision (64-bit) array of data.
  • dataSize: - number of elements in the array.

Parameters:

  • const double *const data
  • size_t dataSize

Return type: SyscOutputScalarData

Function syscGetOutputScalarDataFloat

SyscOutputScalarData syscGetOutputScalarDataFloat(const float *const data, size_t dataSize)

Create an output scalar data access struct.

Parameters:

  • data: - pointer to the single-precision (32-bit) array of data.
  • dataSize: - number of elements in the array.

Parameters:

  • const float *const data
  • size_t dataSize

Return type: SyscOutputScalarData

Function syscGetOutputScalarDataInt32

SyscOutputScalarData syscGetOutputScalarDataInt32(const int32_t *const data, size_t dataSize)

Create an output scalar data access struct.

Parameters:

  • data: - pointer to the 32-bit array of integer data.
  • dataSize: - number of elements in the array.

Parameters:

  • const int32_t *const data
  • size_t dataSize

Return type: SyscOutputScalarData

Function syscGetOutputScalarDataInt64

SyscOutputScalarData syscGetOutputScalarDataInt64(const int64_t *const data, size_t dataSize)

Create an output scalar data access struct.

Parameters:

  • data: - pointer to the 64-bit array of integer data.
  • dataSize: - number of elements in the array.

Parameters:

  • const int64_t *const data
  • size_t dataSize

Return type: SyscOutputScalarData

Function syscGetOutputScalarDataUInt16

SyscOutputScalarData syscGetOutputScalarDataUInt16(const uint16_t *const data, size_t dataSize)

Create an output scalar data access struct.

Parameters:

  • data: - pointer to the 16-bit array of unsigned integer data.
  • dataSize: - number of elements in the array.

Parameters:

  • const uint16_t *const data
  • size_t dataSize

Return type: SyscOutputScalarData

Function syscGetOutputScalarDataUInt64

SyscOutputScalarData syscGetOutputScalarDataUInt64(const uint64_t *const data, size_t dataSize)

Create an output scalar data access struct.

Parameters:

  • data: - pointer to the 64-bit array of unsigned integer data.
  • dataSize: - number of elements in the array.

Parameters:

  • const uint64_t *const data
  • size_t dataSize

Return type: SyscOutputScalarData

Source

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

#pragma once

#include "SystemCouplingParticipant/LibraryType.hpp"

#include "SystemCouplingParticipant/syscCommonTypes.h"

#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
  enum SyscPrimitiveType primitiveType; 
  const void* data;                     
  size_t size;                          
} SyscOutputScalarData;

SyscOutputScalarData syscGetOutputScalarData();

SyscOutputScalarData syscGetOutputScalarDataDouble(
  const double* const data,
  size_t dataSize);

SyscOutputScalarData syscGetOutputScalarDataFloat(
  const float* const data,
  size_t dataSize);

SyscOutputScalarData syscGetOutputScalarDataInt32(
  const int32_t* const data,
  size_t dataSize);

SyscOutputScalarData syscGetOutputScalarDataInt64(
  const int64_t* const data,
  size_t dataSize);

SyscOutputScalarData syscGetOutputScalarDataUInt16(
  const uint16_t* const data,
  size_t dataSize);

SyscOutputScalarData syscGetOutputScalarDataUInt64(
  const uint64_t* const data,
  size_t dataSize);

#ifdef __cplusplus
}
#endif

Connect with Ansys