vtkm::VecFromPortal< PortalType > Class Template Reference

A short variable-length array from a window in an ArrayPortal. More...

#include <VecFromPortal.h>

Public Types
using	ComponentType = typename std::remove_const< typename PortalType::ValueType >::type

Public Member Functions
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT	VecFromPortal ()
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT	VecFromPortal (const PortalType &portal, vtkm::IdComponent numComponents=0, vtkm::Id offset=0)
VTKM_EXEC_CONT vtkm::IdComponent	GetNumberOfComponents () const
template<typename T , vtkm::IdComponent DestSize>
VTKM_EXEC_CONT void	CopyInto (vtkm::Vec< T, DestSize > &dest) const
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT vtkm::internal::ArrayPortalValueReference< PortalType >	operator[] (vtkm::IdComponent index) const

Private Attributes
PortalType	Portal
vtkm::IdComponent	NumComponents
vtkm::Id	Offset

Detailed Description

template<typename PortalType>
class vtkm::VecFromPortal< PortalType >

A short variable-length array from a window in an ArrayPortal.

The VecFromPortal class is a Vec-like class that holds an array portal and exposes a small window of that portal as if it were a Vec.

Member Typedef Documentation

ComponentType

template<typename PortalType >

using vtkm::VecFromPortal< PortalType >::ComponentType = typename std::remove_const<typename PortalType::ValueType>::type

Constructor & Destructor Documentation

VecFromPortal() [1/2]

template<typename PortalType >

VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT vtkm::VecFromPortal< PortalType >::VecFromPortal ( )

inline

VecFromPortal() [2/2]

template<typename PortalType >

VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT vtkm::VecFromPortal< PortalType >::VecFromPortal ( const PortalType &  portal, vtkm::IdComponent  numComponents = 0, vtkm::Id  offset = 0  )

inline

Member Function Documentation

CopyInto()

template<typename PortalType >

template<typename T , vtkm::IdComponent DestSize>

VTKM_EXEC_CONT void vtkm::VecFromPortal< PortalType >::CopyInto ( vtkm::Vec< T, DestSize > &  dest ) const

inline

GetNumberOfComponents()

template<typename PortalType >

VTKM_EXEC_CONT vtkm::IdComponent vtkm::VecFromPortal< PortalType >::GetNumberOfComponents ( ) const

inline

operator[]()

template<typename PortalType >

VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC_CONT vtkm::internal::ArrayPortalValueReference<PortalType> vtkm::VecFromPortal< PortalType >::operator[] ( vtkm::IdComponent  index ) const

inline

Member Data Documentation

NumComponents

template<typename PortalType >

vtkm::IdComponent vtkm::VecFromPortal< PortalType >::NumComponents

private

Offset

template<typename PortalType >

vtkm::Id vtkm::VecFromPortal< PortalType >::Offset

private

Portal

template<typename PortalType >

PortalType vtkm::VecFromPortal< PortalType >::Portal

private

---

The documentation for this class was generated from the following file:

• VecFromPortal.h