Skip to main content

Class sysc::OutputScalarData

Definition: OutputScalarData.hpp (line 24)

Provide a class for output scalar data.

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

Members​

Private attributes​

Variable m_dataType​

Definition: OutputScalarData.hpp (line 182)

sysc::PrimitiveType sysc::OutputScalarData::m_dataType {sysc::Double}

Type: sysc::PrimitiveType

Variable m_data​

Definition: OutputScalarData.hpp (line 183)

const void* sysc::OutputScalarData::m_data {nullptr}

Type: const void *

Variable m_size​

Definition: OutputScalarData.hpp (line 184)

std::size_t sysc::OutputScalarData::m_size {0}

Type: std::size_t

Public functions​

Function OutputScalarData​

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.

Parameters:

  • const double * data
  • std::size_t size

Return type:

Function OutputScalarData​

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.

Parameters:

  • const float * data
  • std::size_t size

Return type:

Function OutputScalarData​

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

Provide a constructor for output scalar data.

Parameters:

  • data: Reference to STL vector of doubles.

Parameters:

  • const std::vector< double > & data

Return type:

Function OutputScalarData​

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

Provide a constructor for output scalar data.

Parameters:

  • data: Reference to STL vector of floats.

Parameters:

  • const std::vector< float > & data

Return type:

Function OutputScalarData​

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:

  • data: Pointer to the first index in the array of unsigned 16-bit integers.
  • size: Number of elements in the array of unsigned 16-bit integers.

Parameters:

  • const std::uint16_t * data
  • std::size_t size

Return type:

Function OutputScalarData​

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:

  • data: Reference to STL vector of unsigned 16-bit integers.

Parameters:

  • const std::vector< std::uint16_t > & data

Return type:

Function OutputScalarData​

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:

  • data: Pointer to the first index in the array of unsigned 64-bit integers.
  • size: Number of elements in the array of unsigned 64-bit integers.

Parameters:

  • const std::uint64_t * data
  • std::size_t size

Return type:

Function OutputScalarData​

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:

  • data: Reference to STL vector of unsigned 64-bit integers.

Parameters:

  • const std::vector< std::uint64_t > & data

Return type:

Function OutputScalarData​

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:

  • data: Pointer to the first index in the array of unsigned 32-bit integers.
  • size: Number of elements in the array of unsigned 16-bit integers.

Parameters:

  • const std::int32_t * data
  • std::size_t size

Return type:

Function OutputScalarData​

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:

  • data: Reference to STL vector of 32-bit integers.

Parameters:

  • const std::vector< std::int32_t > & data

Return type:

Function OutputScalarData​

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:

  • data: Pointer to the first index in the array of unsigned 64-bit integers.
  • size: Number of elements in the array of unsigned 64-bit integers.

Parameters:

  • const std::int64_t * data
  • std::size_t size

Return type:

Function OutputScalarData​

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:

  • data: Reference to STL vector of 64-bit integers.

Parameters:

  • const std::vector< std::int64_t > & data

Return type:

Function OutputScalarData​

sysc::OutputScalarData::OutputScalarData()=default

Provide a default constructor.

Return type:

Function OutputScalarData​

sysc::OutputScalarData::OutputScalarData(const OutputScalarData &)=default

Provide a copy-constructor.

Parameters:

Return type:

Function OutputScalarData​

sysc::OutputScalarData::OutputScalarData(OutputScalarData &&)=default

Provide a move-constructor.

Parameters:

Return type:

Function operator=​

OutputScalarData& sysc::OutputScalarData::operator=(const OutputScalarData &)=default

Provide a copy-assign operator.

Parameters:

Return type: OutputScalarData &

Function operator=​

OutputScalarData& sysc::OutputScalarData::operator=(OutputScalarData &&)=default

Provide a move-assign operator.

Parameters:

Return type: OutputScalarData &

Function size​

std::size_t sysc::OutputScalarData::size() const noexcept

Get the size of data.

Return type: std::size_t

Function empty​

bool sysc::OutputScalarData::empty() const noexcept

Check if array "data" is empty.

Return type: bool

Function getDataType​

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

Get the primitive type of data.

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

Return type: sysc::PrimitiveType

Function getData​

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

Get the pointer to the data.

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

Return type: const void *

References:

Last updated on by rborsaru-ansys