VTK  9.4.20241211
Public Types | Public Member Functions | Static Public Attributes | List of all members
vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray > Struct Template Reference

#include <vtkDataArrayValueRange_Generic.h>

Inheritance diagram for vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >:
[legend]

Public Types

using ArrayType = ArrayTypeT
 
using ValueType = GetAPIType< ArrayType, ForceValueTypeForVtkDataArray >
 
using IteratorType = ValueIterator< ArrayType, TupleSize, ForceValueTypeForVtkDataArray >
 
using ConstIteratorType = ConstValueIterator< ArrayType, TupleSize, ForceValueTypeForVtkDataArray >
 
using ReferenceType = ValueReference< ArrayType, TupleSize, ForceValueTypeForVtkDataArray >
 
using ConstReferenceType = ConstValueReference< ArrayType, TupleSize, ForceValueTypeForVtkDataArray >
 
using value_type = ValueType
 
using size_type = ValueIdType
 
using iterator = IteratorType
 
using const_iterator = ConstIteratorType
 
using reference = ReferenceType
 
using const_reference = ConstReferenceType
 

Public Member Functions

VTK_ITER_INLINE ValueRange () noexcept=default
 
VTK_ITER_INLINE ValueRange (ArrayType *arr, ValueIdType beginValue, ValueIdType endValue) noexcept
 
VTK_ITER_INLINE ValueRange GetSubRange (ValueIdType beginValue=0, ValueIdType endValue=-1) const noexcept
 
VTK_ITER_INLINE ArrayTypeGetArray () const noexcept
 
VTK_ITER_INLINE ComponentIdType GetTupleSize () const noexcept
 
VTK_ITER_INLINE ValueIdType GetBeginValueId () const noexcept
 
VTK_ITER_INLINE ValueIdType GetEndValueId () const noexcept
 
VTK_ITER_INLINE size_type size () const noexcept
 
VTK_ITER_INLINE iterator begin () noexcept
 
VTK_ITER_INLINE iterator end () noexcept
 
VTK_ITER_INLINE const_iterator begin () const noexcept
 
VTK_ITER_INLINE const_iterator end () const noexcept
 
VTK_ITER_INLINE const_iterator cbegin () const noexcept
 
VTK_ITER_INLINE const_iterator cend () const noexcept
 
VTK_ITER_INLINE reference operator[] (size_type i) noexcept
 
VTK_ITER_INLINE const_reference operator[] (size_type i) const noexcept
 
value_typedata () noexcept
 
value_typedata () const noexcept
 

Static Public Attributes

static constexpr ComponentIdType TupleSizeTag = TupleSize
 

Detailed Description

template<typename ArrayTypeT, ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray>
struct vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >

Definition at line 864 of file vtkDataArrayValueRange_Generic.h.

Member Typedef Documentation

◆ ArrayType

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::ArrayType = ArrayTypeT

Definition at line 874 of file vtkDataArrayValueRange_Generic.h.

◆ ValueType

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::ValueType = GetAPIType<ArrayType, ForceValueTypeForVtkDataArray>

Definition at line 875 of file vtkDataArrayValueRange_Generic.h.

◆ IteratorType

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::IteratorType = ValueIterator<ArrayType, TupleSize, ForceValueTypeForVtkDataArray>

Definition at line 877 of file vtkDataArrayValueRange_Generic.h.

◆ ConstIteratorType

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::ConstIteratorType = ConstValueIterator<ArrayType, TupleSize, ForceValueTypeForVtkDataArray>

Definition at line 878 of file vtkDataArrayValueRange_Generic.h.

◆ ReferenceType

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::ReferenceType = ValueReference<ArrayType, TupleSize, ForceValueTypeForVtkDataArray>

Definition at line 879 of file vtkDataArrayValueRange_Generic.h.

◆ ConstReferenceType

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::ConstReferenceType = ConstValueReference<ArrayType, TupleSize, ForceValueTypeForVtkDataArray>

Definition at line 880 of file vtkDataArrayValueRange_Generic.h.

◆ value_type

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::value_type = ValueType

Definition at line 887 of file vtkDataArrayValueRange_Generic.h.

◆ size_type

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::size_type = ValueIdType

Definition at line 888 of file vtkDataArrayValueRange_Generic.h.

◆ iterator

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::iterator = IteratorType

Definition at line 889 of file vtkDataArrayValueRange_Generic.h.

◆ const_iterator

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::const_iterator = ConstIteratorType

Definition at line 890 of file vtkDataArrayValueRange_Generic.h.

◆ reference

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::reference = ReferenceType

Definition at line 891 of file vtkDataArrayValueRange_Generic.h.

◆ const_reference

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
using vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::const_reference = ConstReferenceType

Definition at line 892 of file vtkDataArrayValueRange_Generic.h.

Constructor & Destructor Documentation

◆ ValueRange() [1/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::ValueRange ( )
defaultnoexcept

◆ ValueRange() [2/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::ValueRange ( ArrayType arr,
ValueIdType  beginValue,
ValueIdType  endValue 
)
inlinenoexcept

Definition at line 898 of file vtkDataArrayValueRange_Generic.h.

Member Function Documentation

◆ GetSubRange()

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE ValueRange vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::GetSubRange ( ValueIdType  beginValue = 0,
ValueIdType  endValue = -1 
) const
inlinenoexcept

Definition at line 910 of file vtkDataArrayValueRange_Generic.h.

◆ GetArray()

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE ArrayType * vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::GetArray ( ) const
inlinenoexcept

Definition at line 920 of file vtkDataArrayValueRange_Generic.h.

◆ GetTupleSize()

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE ComponentIdType vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::GetTupleSize ( ) const
inlinenoexcept

Definition at line 922 of file vtkDataArrayValueRange_Generic.h.

◆ GetBeginValueId()

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE ValueIdType vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::GetBeginValueId ( ) const
inlinenoexcept

Definition at line 925 of file vtkDataArrayValueRange_Generic.h.

◆ GetEndValueId()

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE ValueIdType vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::GetEndValueId ( ) const
inlinenoexcept

Definition at line 928 of file vtkDataArrayValueRange_Generic.h.

◆ size()

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE size_type vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::size ( ) const
inlinenoexcept

Definition at line 931 of file vtkDataArrayValueRange_Generic.h.

◆ begin() [1/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE iterator vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::begin ( )
inlinenoexcept

Definition at line 937 of file vtkDataArrayValueRange_Generic.h.

◆ end() [1/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE iterator vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::end ( )
inlinenoexcept

Definition at line 939 of file vtkDataArrayValueRange_Generic.h.

◆ begin() [2/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE const_iterator vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::begin ( ) const
inlinenoexcept

Definition at line 942 of file vtkDataArrayValueRange_Generic.h.

◆ end() [2/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE const_iterator vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::end ( ) const
inlinenoexcept

Definition at line 944 of file vtkDataArrayValueRange_Generic.h.

◆ cbegin()

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE const_iterator vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::cbegin ( ) const
inlinenoexcept

Definition at line 947 of file vtkDataArrayValueRange_Generic.h.

◆ cend()

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE const_iterator vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::cend ( ) const
inlinenoexcept

Definition at line 949 of file vtkDataArrayValueRange_Generic.h.

◆ operator[]() [1/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE reference vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::operator[] ( size_type  i)
inlinenoexcept

Definition at line 952 of file vtkDataArrayValueRange_Generic.h.

◆ operator[]() [2/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
VTK_ITER_INLINE const_reference vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::operator[] ( size_type  i) const
inlinenoexcept

Definition at line 957 of file vtkDataArrayValueRange_Generic.h.

◆ data() [1/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
value_type * vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::data ( )
inlinenoexcept
Warning
Just be sure you know the repercussions of using data(). Only use when absolutely necessary. If the value_type is not the real underlying type of the vtkDataArray, this method returns invalid values in some cases. Ex: the elements are completely different when an array of 32-bit floats is reinterpreted as an array of unsigned 8-bit integer,

Definition at line 970 of file vtkDataArrayValueRange_Generic.h.

◆ data() [2/2]

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
value_type * vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::data ( ) const
inlinenoexcept
Warning
Just be sure you know the repercussions of using data(). Only use when absolutely necessary. If the value_type is not the real underlying type of the vtkDataArray, this method returns invalid values in some cases. Ex: the elements are completely different when an array of 32-bit floats is reinterpreted as an array of unsigned 8-bit integer,

Definition at line 974 of file vtkDataArrayValueRange_Generic.h.

Member Data Documentation

◆ TupleSizeTag

template<typename ArrayTypeT , ComponentIdType TupleSize, typename ForceValueTypeForVtkDataArray >
constexpr ComponentIdType vtk::detail::ValueRange< ArrayTypeT, TupleSize, ForceValueTypeForVtkDataArray >::TupleSizeTag = TupleSize
staticconstexpr

Definition at line 884 of file vtkDataArrayValueRange_Generic.h.


The documentation for this struct was generated from the following files: