## On this page

  

 

 # ansys::dpf::FieldCursor Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

[dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) \* [data](classansys_1_1dpf_1_1FieldCursor.xhtml#a815f0d760f113116cb5ed55b9ec9f584) () const [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) &amp; [operator\[\]](classansys_1_1dpf_1_1FieldCursor.xhtml#a00beb09a53d6fd59dcd80dd21f698895) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) index) const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [size](classansys_1_1dpf_1_1FieldCursor.xhtml#a088f17f2b7eec6cd4470ece35f0dc01a) () const [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) [id](classansys_1_1dpf_1_1FieldCursor.xhtml#a4a87616f5f17ac420f0499170efcf454) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [n\_component](classansys_1_1dpf_1_1FieldCursor.xhtml#a907fd15815ec3ffbd89cdc3a5b2ba5ca) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [n\_elementary\_data](classansys_1_1dpf_1_1FieldCursor.xhtml#a546e38c5c0b76a50350946e11718a9d3) () const [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [data\_first\_index](classansys_1_1dpf_1_1FieldCursor.xhtml#aac74361ccc8826b47e26aff3215038a7) () const bool [defined](classansys_1_1dpf_1_1FieldCursor.xhtml#afb033c6e098f2aebf9b8c6da12608891) () const <a id="details" name="details"></a>## Detailed Description

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

Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#_a31).

## Member Function Documentation

<a id="a815f0d760f113116cb5ed55b9ec9f584" name="a815f0d760f113116cb5ed55b9ec9f584"></a>## [◆ ](#a815f0d760f113116cb5ed55b9ec9f584)data()

 [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) \* ansys::dpf::FieldCursor::data  ( )  const  inline 

ReturnsPointer to field data. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a36).



<a id="aac74361ccc8826b47e26aff3215038a7" name="aac74361ccc8826b47e26aff3215038a7"></a>## [◆ ](#aac74361ccc8826b47e26aff3215038a7)data\_first\_index()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::FieldCursor::data\_first\_index  ( )  const  inline 

ReturnsIndex of first entry in field data. 



<a id="afb033c6e098f2aebf9b8c6da12608891" name="afb033c6e098f2aebf9b8c6da12608891"></a>## [◆ ](#afb033c6e098f2aebf9b8c6da12608891)defined()

 bool ansys::dpf::FieldCursor::defined  ( )  const  inline 

ReturnsIndication that field defined 



<a id="a4a87616f5f17ac420f0499170efcf454" name="a4a87616f5f17ac420f0499170efcf454"></a>## [◆ ](#a4a87616f5f17ac420f0499170efcf454)id()

 [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) ansys::dpf::FieldCursor::id  ( )  const  inline 

ReturnsId of field. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a33).



<a id="a907fd15815ec3ffbd89cdc3a5b2ba5ca" name="a907fd15815ec3ffbd89cdc3a5b2ba5ca"></a>## [◆ ](#a907fd15815ec3ffbd89cdc3a5b2ba5ca)n\_component()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::FieldCursor::n\_component  ( )  const  inline 

ReturnsNumber of components in field data. 



<a id="a546e38c5c0b76a50350946e11718a9d3" name="a546e38c5c0b76a50350946e11718a9d3"></a>## [◆ ](#a546e38c5c0b76a50350946e11718a9d3)n\_elementary\_data()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::FieldCursor::n\_elementary\_data  ( )  const  inline 

ReturnsNumber of entries in field data. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a35).



<a id="a00beb09a53d6fd59dcd80dd21f698895" name="a00beb09a53d6fd59dcd80dd21f698895"></a>## [◆ ](#a00beb09a53d6fd59dcd80dd21f698895)operator\[\]()

 [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) &amp; ansys::dpf::FieldCursor::operator\[\]  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *index*)  const  inline 

Returns[Field](classansys_1_1dpf_1_1Field.xhtml) data at given index. Parameters \[in\]indexIndex of data within field. 



<a id="a088f17f2b7eec6cd4470ece35f0dc01a" name="a088f17f2b7eec6cd4470ece35f0dc01a"></a>## [◆ ](#a088f17f2b7eec6cd4470ece35f0dc01a)size()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::FieldCursor::size  ( )  const  inline 

ReturnsSize of field data. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a34).