System Coupling C++ library 2024 R2

sysc::OutputVectorData Class Reference

Last update: 17.07.2025

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

#include <OutputVectorData.hpp>

Public Member Functions

 OutputVectorData (const double *data, std::size_t size)
 Provide a constructor for output vector data with compact storage.
 
 OutputVectorData (const double *data, std::size_t size, Dimension dimension)
 Provide a constructor for 2D output vector data with compact storage.
 
 OutputVectorData (const float *data, std::size_t size)
 Provide a constructor for output vector data with compact storage.
 
 OutputVectorData (const float *data, std::size_t size, Dimension dimension)
 Provide a constructor for 2D output vector data with compact storage.
 
 OutputVectorData (const std::vector< double > &data)
 Provide a constructor for output vector data with compact storage.
 
 OutputVectorData (const std::vector< double > &data, Dimension dimension)
 Provide a constructor for 2D output vector data with compact storage.
 
 OutputVectorData (const std::vector< float > &data)
 Provide a constructor for output vector data with compact storage.
 
 OutputVectorData (const std::vector< float > &data, Dimension dimension)
 Provide a constructor for 2D output vector data with compact storage.
 
 OutputVectorData (const double *data0, const double *data1, const double *data2, std::size_t size)
 Create an output vector data access object with split storage.
 
 OutputVectorData (const double *data0, const double *data1, std::size_t size)
 Create an 2D output vector data access object with split storage.
 
 OutputVectorData (const float *data0, const float *data1, const float *data2, std::size_t size)
 Create an output vector data access object with split storage.
 
 OutputVectorData (const float *data0, const float *data1, std::size_t size)
 Create an 2D output vector data access object with split storage.
 
 OutputVectorData (const std::vector< double > &data0, const std::vector< double > &data1, const std::vector< double > &data2)
 Create an output vector data access object with split storage.
 
 OutputVectorData (const std::vector< double > &data0, const std::vector< double > &data1)
 Create an 2D output vector data access object with split storage.
 
 OutputVectorData (const std::vector< float > &data0, const std::vector< float > &data1, const std::vector< float > &data2)
 Create an output vector data access object with split storage.
 
 OutputVectorData (const std::vector< float > &data0, const std::vector< float > &data1)
 Create an 2D output vector data access object with split storage.
 
 OutputVectorData ()=default
 Provide a default constructor.
 
 OutputVectorData (const OutputVectorData &)=default
 Provide a copy-constructor.
 
 OutputVectorData (OutputVectorData &&)=default
 Provide a move-constructor.
 
OutputVectorData & operator= (const OutputVectorData &)=default
 Provide a copy-assign operator.
 
OutputVectorData & operator= (OutputVectorData &&)=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 isSplitVector () const noexcept
 Query whether it's a split or compact vector layout.
 
const void * getData0 () const noexcept
 Get pointer to data0.
 
const void * getData1 () const noexcept
 Get pointer to data1.
 
const void * getData2 () const noexcept
 Get pointer to data2.
 
Dimension getDimension () const noexcept
 Get the Dimension object.
 

Detailed Description

Provide a class for output vector data.

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

The size is the total number of vectors, not the total number of components, i.e. if all data is stored in one contiguous array, then size is 1/3 the size of that array.

Definition at line 27 of file OutputVectorData.hpp.

Constructor & Destructor Documentation

◆ OutputVectorData() [1/16]

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

Provide a constructor for output vector data with compact storage.

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

◆ OutputVectorData() [2/16]

sysc::OutputVectorData::OutputVectorData ( const double *  data,
std::size_t  size,
Dimension  dimension 
)

Provide a constructor for 2D output vector data with compact storage.

Parameters
data- pointer to the array of double-precision data.
size- number of vectors.
dimension- dimension of double-precision vector data.

◆ OutputVectorData() [3/16]

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

Provide a constructor for output vector data with compact storage.

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

◆ OutputVectorData() [4/16]

sysc::OutputVectorData::OutputVectorData ( const float *  data,
std::size_t  size,
Dimension  dimension 
)

Provide a constructor for 2D output vector data with compact storage.

Parameters
data- pointer to the array of single-precision data.
size- number of vectors.
dimension- dimension of single-precision vector data.

◆ OutputVectorData() [5/16]

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

Provide a constructor for output vector data with compact storage.

Parameters
data- reference to the STL vector of double-precision data.

◆ OutputVectorData() [6/16]

sysc::OutputVectorData::OutputVectorData ( const std::vector< double > &  data,
Dimension  dimension 
)

Provide a constructor for 2D output vector data with compact storage.

Parameters
data- reference to the STL vector of double-precision data.
dimension- dimension of double-precision vector data.

◆ OutputVectorData() [7/16]

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

Provide a constructor for output vector data with compact storage.

Parameters
data- reference to the STL vector of single-precision data.

◆ OutputVectorData() [8/16]

sysc::OutputVectorData::OutputVectorData ( const std::vector< float > &  data,
Dimension  dimension 
)

Provide a constructor for 2D output vector data with compact storage.

Parameters
data- reference to the STL vector of single-precision data.
dimension- dimension of single-precision vector data.

◆ OutputVectorData() [9/16]

sysc::OutputVectorData::OutputVectorData ( const double *  data0,
const double *  data1,
const double *  data2,
std::size_t  size 
)

Create an output vector data access object with split storage.

Parameters
data0- pointer to the first array of double-precision data.
data1- pointer to the second array of double-precision data.
data2- pointer to the third array of double-precision data.
size- number of vectors.

◆ OutputVectorData() [10/16]

sysc::OutputVectorData::OutputVectorData ( const double *  data0,
const double *  data1,
std::size_t  size 
)

Create an 2D output vector data access object with split storage.

Parameters
data0- pointer to the first array of double-precision data.
data1- pointer to the second array of double-precision data.
size- number of vectors.

◆ OutputVectorData() [11/16]

sysc::OutputVectorData::OutputVectorData ( const float *  data0,
const float *  data1,
const float *  data2,
std::size_t  size 
)

Create an output vector data access object with split storage.

Parameters
data0- pointer to the first array of single-precision data.
data1- pointer to the second array of single-precision data.
data2- pointer to the third array of single-precision data.
size- number of vectors.

◆ OutputVectorData() [12/16]

sysc::OutputVectorData::OutputVectorData ( const float *  data0,
const float *  data1,
std::size_t  size 
)

Create an 2D output vector data access object with split storage.

Parameters
data0- pointer to the first array of single-precision data.
data1- pointer to the second array of single-precision data.
size- number of vectors.

◆ OutputVectorData() [13/16]

sysc::OutputVectorData::OutputVectorData ( const std::vector< double > &  data0,
const std::vector< double > &  data1,
const std::vector< double > &  data2 
)

Create an output vector data access object with split storage.

Parameters
data0- reference to the first STL vector of double-precision data.
data1- reference to the second STL vector of double-precision data.
data2- reference to the third STL vector of double-precision data.

◆ OutputVectorData() [14/16]

sysc::OutputVectorData::OutputVectorData ( const std::vector< double > &  data0,
const std::vector< double > &  data1 
)

Create an 2D output vector data access object with split storage.

Parameters
data0- reference to the first STL vector of double-precision data.
data1- reference to the second STL vector of double-precision data.

◆ OutputVectorData() [15/16]

sysc::OutputVectorData::OutputVectorData ( const std::vector< float > &  data0,
const std::vector< float > &  data1,
const std::vector< float > &  data2 
)

Create an output vector data access object with split storage.

Parameters
data0- reference to the first STL vector of single-precision data.
data1- reference to the second STL vector of single-precision data.
data2- reference to the third STL vector of single-precision data.

◆ OutputVectorData() [16/16]

sysc::OutputVectorData::OutputVectorData ( const std::vector< float > &  data0,
const std::vector< float > &  data1 
)

Create an 2D output vector data access object with split storage.

Parameters
data0- reference to the first STL vector of single-precision data.
data1- reference to the second STL vector of single-precision data.

Member Function Documentation

◆ getData0()

const void * sysc::OutputVectorData::getData0 ( ) const
noexcept

Get pointer to data0.

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

◆ getData1()

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

Get pointer to data1.

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

◆ getData2()

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

Get pointer to data2.

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

◆ getDataType()

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

Get the primitive type of data.

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

◆ getDimension()

Dimension sysc::OutputVectorData::getDimension ( ) const
noexcept

Get the Dimension object.

Returns
const Dimension

References sysc::Double.

◆ isSplitVector()

bool sysc::OutputVectorData::isSplitVector ( ) const
noexcept

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

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

Connect with Ansys