System Coupling C++ library 2024 R2

sysc::OutputComplexScalarData Class Reference

Last update: 17.07.2025

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

#include <OutputComplexScalarData.hpp>

Public Member Functions

 OutputComplexScalarData (const std::vector< std::complex< double > > &dataComplex)
 Provide a constructor for output complex scalar data with compact storage for complex components.
 
 OutputComplexScalarData (const std::complex< double > *dataComplex, std::size_t size)
 Provide a constructor for output complex scalar data with compact storage for complex components.
 
 OutputComplexScalarData (const double *dataComplex, std::size_t size)
 Provide a constructor for output complex scalar data with compact storage for complex components.
 
 OutputComplexScalarData (const std::vector< double > &dataReal, const std::vector< double > &dataImaginary)
 Create an output complex scalar data access object with split storage for compex components.
 
 OutputComplexScalarData (const double *dataReal, const double *dataImaginary, std::size_t size)
 Create an output complex scalar data access object with split storage for compex components.
 
 OutputComplexScalarData (const std::vector< std::complex< float > > &dataComplex)
 Provide a constructor for output complex scalar data with compact storage for complex components.
 
 OutputComplexScalarData (const std::complex< float > *dataComplex, std::size_t size)
 Provide a constructor for output complex scalar data with compact storage for complex components.
 
 OutputComplexScalarData (const float *dataComplex, std::size_t size)
 Provide a constructor for output complex scalar data with compact storage for complex components.
 
 OutputComplexScalarData (const std::vector< float > &dataReal, const std::vector< float > &dataImaginary)
 Create an output complex scalar data access object with split storage for compex components.
 
 OutputComplexScalarData (const float *dataReal, const float *dataImaginary, std::size_t size)
 Create an output complex scalar data access object with split storage for compex components.
 
 OutputComplexScalarData ()=default
 Provide a default constructor.
 
 OutputComplexScalarData (const OutputComplexScalarData &)=default
 Provide a copy-constructor.
 
 OutputComplexScalarData (OutputComplexScalarData &&)=default
 Provide a move-constructor.
 
OutputComplexScalarData & operator= (const OutputComplexScalarData &)=default
 Provide a copy-assign operator.
 
OutputComplexScalarData & operator= (OutputComplexScalarData &&)=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.
 
bool isSplitComplex () const noexcept
 Query whether it's a split or compact vector layout.
 
const void * getData1 () const noexcept
 Get pointer to data1.
 
const void * getData2 () const noexcept
 Get pointer to data2.
 

Detailed Description

Provide a class for output complex scalar data.

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

Definition at line 24 of file OutputComplexScalarData.hpp.

Constructor & Destructor Documentation

◆ OutputComplexScalarData() [1/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const std::vector< std::complex< double > > &  dataComplex)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters
dataComplex- reference to the STL vector of complex double-precision data

◆ OutputComplexScalarData() [2/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const std::complex< double > *  dataComplex,
std::size_t  size 
)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters
dataComplex- pointer to an array of complex double-precision scalars
size- number of scalars

◆ OutputComplexScalarData() [3/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const double *  dataComplex,
std::size_t  size 
)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters
dataComplex- pointer to an array of complex double-precision scalars
size- number of scalars

◆ OutputComplexScalarData() [4/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const std::vector< double > &  dataReal,
const std::vector< double > &  dataImaginary 
)

Create an output complex scalar data access object with split storage for compex components.

Parameters
dataReal- reference to an STL vector of double-precision data, that stores the real components of the complex scalars.
dataImaginary- reference to an STL vector of double-precision data, that stores the imaginary components of the complex scalars.

◆ OutputComplexScalarData() [5/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const double *  dataReal,
const double *  dataImaginary,
std::size_t  size 
)

Create an output complex scalar data access object with split storage for compex components.

Parameters
dataReal- pointer to an array of double-precision data, that stores the real components of the complex scalars.
dataImaginary- pointer to an array of double-precision data, that stores the imaginary components of the complex scalars.
size- number of complex scalars

◆ OutputComplexScalarData() [6/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const std::vector< std::complex< float > > &  dataComplex)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters
dataComplex- reference to the STL vector of complex single-precision data

◆ OutputComplexScalarData() [7/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const std::complex< float > *  dataComplex,
std::size_t  size 
)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters
dataComplex- pointer to an array of complex single-precision scalars
size- number of scalars

◆ OutputComplexScalarData() [8/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const float *  dataComplex,
std::size_t  size 
)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters
dataComplex- pointer to an array of complex single-precision scalars
size- number of scalars

◆ OutputComplexScalarData() [9/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const std::vector< float > &  dataReal,
const std::vector< float > &  dataImaginary 
)

Create an output complex scalar data access object with split storage for compex components.

Parameters
dataReal- reference to an STL vector of single-precision data, that stores the real components of the complex scalars.
dataImaginary- reference to an STL vector of single-precision data, that stores the imaginary components of the complex scalars.

◆ OutputComplexScalarData() [10/10]

sysc::OutputComplexScalarData::OutputComplexScalarData ( const float *  dataReal,
const float *  dataImaginary,
std::size_t  size 
)

Create an output complex scalar data access object with split storage for compex components.

Parameters
dataReal- pointer to an array of single-precision data, that stores the real components of the complex scalars.
dataImaginary- pointer to an array of single-precision data, that stores the imaginary components of the complex scalars.
size- number of complex scalars

Member Function Documentation

◆ getData1()

const void * sysc::OutputComplexScalarData::getData1 ( ) const
noexcept

Get pointer to data1.

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

◆ getData2()

const void * sysc::OutputComplexScalarData::getData2 ( ) const
noexcept

Get pointer to data2.

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

References sysc::Double.

◆ getDataType()

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

Get the primitive type of data.

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

◆ isSplitComplex()

bool sysc::OutputComplexScalarData::isSplitComplex ( ) const
noexcept

Query whether it's a split or compact vector layout.

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

Connect with Ansys