System Coupling C++ library 2024 R2

sysc::OutputScalarData Class Reference

Last update: 17.07.2025

Provide a class for output scalar data. More...

#include <OutputScalarData.hpp>

Public Member Functions

 OutputScalarData (const double *data, std::size_t size)
 Provide a constructor for output scalar data.
 
 OutputScalarData (const float *data, std::size_t size)
 Provide a constructor for output scalar data.
 
 OutputScalarData (const std::vector< double > &data)
 Provide a constructor for output scalar data.
 
 OutputScalarData (const std::vector< float > &data)
 Provide a constructor for output scalar data.
 
 OutputScalarData (const std::uint16_t *data, std::size_t size)
 Provide a constructor for OutputScalarData, which provides read-only access to scalar array of unsigned 16-bit integers.
 
 OutputScalarData (const std::vector< std::uint16_t > &data)
 Provide an STL vector variation of constructor for OutputScalarData, which provides read-only access to scalar array of unsigned 16-bit integers.
 
 OutputScalarData (const std::uint64_t *data, std::size_t size)
 Provide a constructor for OutputScalarData, which provides read-only access to scalar array of unsigned 64-bit integers.
 
 OutputScalarData (const std::vector< std::uint64_t > &data)
 Provide an STL vector variation of constructor for OutputScalarData, which provides read-only access to scalar array of unsigned 64-bit integers.
 
 OutputScalarData (const std::int32_t *data, std::size_t size)
 Provide a constructor for OutputScalarData, which provides read-only access to scalar array of 32-bit integers.
 
 OutputScalarData (const std::vector< std::int32_t > &data)
 Provide an STL vector variation of constructor for OutputScalarData, which provides read-only access to scalar array of 32-bit integers.
 
 OutputScalarData (const std::int64_t *data, std::size_t size)
 Provide a constructor for OutputScalarData, which provides read-only access to scalar array of 64-bit integers.
 
 OutputScalarData (const std::vector< std::int64_t > &data)
 Provide an STL vector variation of constructor for OutputScalarData, which provides read-only access to scalar array of 64-bit integers.
 
 OutputScalarData ()=default
 Provide a default constructor.
 
 OutputScalarData (const OutputScalarData &)=default
 Provide a copy-constructor.
 
 OutputScalarData (OutputScalarData &&)=default
 Provide a move-constructor.
 
OutputScalarData & operator= (const OutputScalarData &)=default
 Provide a copy-assign operator.
 
OutputScalarData & operator= (OutputScalarData &&)=default
 Provide a move-assign operator.
 
std::size_t size () const noexcept
 Get the size of data.
 
bool empty () const noexcept
 Check if array "data" is empty.
 
sysc::PrimitiveType getDataType () const noexcept
 Get the primitive type of data.
 
const void * getData () const noexcept
 Get the pointer to the data.
 

Detailed Description

Provide a class for output scalar data.

Output scalar data provides read-only access to an array of scalar data.

Definition at line 24 of file OutputScalarData.hpp.

Constructor & Destructor Documentation

◆ OutputScalarData() [1/12]

sysc::OutputScalarData::OutputScalarData ( const double *  data,
std::size_t  size 
)

Provide a constructor for output scalar data.

Parameters
data- pointer to the double-precision array of data.
size- number of elements in the array.

◆ OutputScalarData() [2/12]

sysc::OutputScalarData::OutputScalarData ( const float *  data,
std::size_t  size 
)

Provide a constructor for output scalar data.

Parameters
data- pointer to the single-precision array of data.
size- number of elements in the array.

◆ OutputScalarData() [3/12]

sysc::OutputScalarData::OutputScalarData ( const std::vector< double > &  data)

Provide a constructor for output scalar data.

Parameters
dataReference to STL vector of doubles.

◆ OutputScalarData() [4/12]

sysc::OutputScalarData::OutputScalarData ( const std::vector< float > &  data)

Provide a constructor for output scalar data.

Parameters
dataReference to STL vector of floats.

◆ OutputScalarData() [5/12]

sysc::OutputScalarData::OutputScalarData ( const std::uint16_t *  data,
std::size_t  size 
)

Provide a constructor for OutputScalarData, which provides read-only access to scalar array of unsigned 16-bit integers.

Parameters
dataPointer to the first index in the array of unsigned 16-bit integers.
sizeNumber of elements in the array of unsigned 16-bit integers.

◆ OutputScalarData() [6/12]

sysc::OutputScalarData::OutputScalarData ( const std::vector< std::uint16_t > &  data)

Provide an STL vector variation of constructor for OutputScalarData, which provides read-only access to scalar array of unsigned 16-bit integers.

Parameters
dataReference to STL vector of unsigned 16-bit integers.

◆ OutputScalarData() [7/12]

sysc::OutputScalarData::OutputScalarData ( const std::uint64_t *  data,
std::size_t  size 
)

Provide a constructor for OutputScalarData, which provides read-only access to scalar array of unsigned 64-bit integers.

Parameters
dataPointer to the first index in the array of unsigned 64-bit integers.
sizeNumber of elements in the array of unsigned 64-bit integers.

◆ OutputScalarData() [8/12]

sysc::OutputScalarData::OutputScalarData ( const std::vector< std::uint64_t > &  data)

Provide an STL vector variation of constructor for OutputScalarData, which provides read-only access to scalar array of unsigned 64-bit integers.

Parameters
dataReference to STL vector of unsigned 64-bit integers.

◆ OutputScalarData() [9/12]

sysc::OutputScalarData::OutputScalarData ( const std::int32_t *  data,
std::size_t  size 
)

Provide a constructor for OutputScalarData, which provides read-only access to scalar array of 32-bit integers.

Parameters
dataPointer to the first index in the array of unsigned 32-bit integers.
sizeNumber of elements in the array of unsigned 16-bit integers.

◆ OutputScalarData() [10/12]

sysc::OutputScalarData::OutputScalarData ( const std::vector< std::int32_t > &  data)

Provide an STL vector variation of constructor for OutputScalarData, which provides read-only access to scalar array of 32-bit integers.

Parameters
dataReference to STL vector of 32-bit integers.

◆ OutputScalarData() [11/12]

sysc::OutputScalarData::OutputScalarData ( const std::int64_t *  data,
std::size_t  size 
)

Provide a constructor for OutputScalarData, which provides read-only access to scalar array of 64-bit integers.

Parameters
dataPointer to the first index in the array of unsigned 64-bit integers.
sizeNumber of elements in the array of unsigned 64-bit integers.

◆ OutputScalarData() [12/12]

sysc::OutputScalarData::OutputScalarData ( const std::vector< std::int64_t > &  data)

Provide an STL vector variation of constructor for OutputScalarData, which provides read-only access to scalar array of 64-bit integers.

Parameters
dataReference to STL vector of 64-bit integers.

Member Function Documentation

◆ getData()

const void * sysc::OutputScalarData::getData ( ) const
noexcept

Get the pointer to the data.

For internal use only (no back-compatibility guarantee).

References sysc::Double.

◆ getDataType()

sysc::PrimitiveType sysc::OutputScalarData::getDataType ( ) const
noexcept

Get the primitive type of data.

For internal use only (no back-compatibility guarantee).

Connect with Ansys