DPF C++ client library 2023 R2

ansys::dpf::FieldCursor Class Reference

Last update: 10.07.2023

#include <dpf_api.h>

Public Member Functions

dp_double * data () const
 
dp_double & operator[] (dp_int index) const
 
dp_int size () const
 
dp_id id () const
 
dp_int n_component () const
 
dp_int n_elementary_data () const
 
dp_int data_first_index () const
 
bool defined () const
 

Detailed Description

Represents a complete entity data (id, size, num elementary data).

Examples
DataApis.cpp.

Member Function Documentation

◆ data()

dp_double * ansys::dpf::FieldCursor::data ( ) const
inline
Returns
Pointer to field data.
Examples
DataApis.cpp.

◆ data_first_index()

dp_int ansys::dpf::FieldCursor::data_first_index ( ) const
inline
Returns
Index of first entry in field data.

◆ defined()

bool ansys::dpf::FieldCursor::defined ( ) const
inline
Returns
Indication that field defined

◆ id()

dp_id ansys::dpf::FieldCursor::id ( ) const
inline
Returns
Id of field.
Examples
DataApis.cpp.

◆ n_component()

dp_int ansys::dpf::FieldCursor::n_component ( ) const
inline
Returns
Number of components in field data.

◆ n_elementary_data()

dp_int ansys::dpf::FieldCursor::n_elementary_data ( ) const
inline
Returns
Number of entries in field data.
Examples
DataApis.cpp.

◆ operator[]()

dp_double & ansys::dpf::FieldCursor::operator[] ( dp_int  index) const
inline
Returns
Field data at given index.
Parameters
[in]indexIndex of data within field.

◆ size()

dp_int ansys::dpf::FieldCursor::size ( ) const
inline
Returns
Size of field data.
Examples
DataApis.cpp.

Connect with Ansys