vtkArrayIteratorTemplate.h 4.04 KB
Newer Older
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkArrayIteratorTemplate.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
15 16 17
// .NAME vtkArrayIteratorTemplate - Implementation template for a array
// iterator.
//
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
18
// .SECTION Description
19 20 21
// This is implementation template for a array iterator. It only works
// with arrays that have a contiguous internal storage of values (as in
// vtkDataArray, vtkStringArray).
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
22

23 24
#ifndef vtkArrayIteratorTemplate_h
#define vtkArrayIteratorTemplate_h
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
25

26
#include "vtkCommonCoreModule.h" // For export macro
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
27 28
#include "vtkArrayIterator.h"

29 30 31 32
#include "vtkStdString.h" // For template instantiation
#include "vtkUnicodeString.h" // For template instantiation
#include "vtkVariant.h" // For template instantiation

Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
33
template <class T>
34
class VTKCOMMONCORE_EXPORT vtkArrayIteratorTemplate : public vtkArrayIterator
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
35 36 37
{
public:
  static vtkArrayIteratorTemplate<T>* New();
38
  vtkTemplateTypeMacro(vtkArrayIteratorTemplate<T>, vtkArrayIterator)
39
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
40

Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
41 42 43
  // Description:
  // Set the array this iterator will iterate over.
  // After Initialize() has been called, the iterator is valid
44
  // so long as the Array has not been modified
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
45 46
  // (except using the iterator itself).
  // If the array is modified, the iterator must be re-intialized.
47
  void Initialize(vtkAbstractArray* array) VTK_OVERRIDE;
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
48 49 50 51 52

  // Description:
  // Get the array.
  vtkAbstractArray* GetArray(){ return this->Array; }

53

Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
54 55 56 57 58 59 60 61 62
  // Description:
  // Must be called only after Initialize.
  T* GetTuple(vtkIdType id);

  // Description:
  // Must be called only after Initialize.
  T& GetValue(vtkIdType id)
    { return this->Pointer[id]; }

63
  // Description:
64 65 66
  // Sets the value at the index. This does not verify if the index is
  // valid.  The caller must ensure that id is less than the maximum
  // number of values.
67 68 69 70 71
  void SetValue(vtkIdType id, T value)
    {
    this->Pointer[id] = value;
    }

Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85
  // Description:
  // Must be called only after Initialize.
  vtkIdType GetNumberOfTuples();

  // Description:
  // Must be called only after Initialize.
  vtkIdType GetNumberOfValues();

  // Description:
  // Must be called only after Initialize.
  int GetNumberOfComponents();

  // Description:
  // Get the data type from the underlying array.
86
  int GetDataType() VTK_OVERRIDE;
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100

  // Description:
  // Get the data type size from the underlying array.
  int GetDataTypeSize();

  // Description:
  // This is the data type for the value.
  typedef T ValueType;
protected:
  vtkArrayIteratorTemplate();
  ~vtkArrayIteratorTemplate();

  T* Pointer;
private:
101
  vtkArrayIteratorTemplate(const vtkArrayIteratorTemplate&) VTK_DELETE_FUNCTION;
102
  void operator=(const vtkArrayIteratorTemplate&) VTK_DELETE_FUNCTION;
Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
103 104 105 106 107

 void SetArray(vtkAbstractArray*);
 vtkAbstractArray* Array;
};

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
#ifdef VTK_USE_EXTERN_TEMPLATE
#ifndef vtkArrayIteratorTemplateInstantiate_cxx
#ifdef _MSC_VER
#pragma warning (push)
// The following is needed when the vtkArrayIteratorTemplate is declared
// dllexport and is used from another class in vtkCommonCore
#pragma warning (disable: 4910) // extern and dllexport incompatible
#endif
vtkInstantiateTemplateMacro(
  extern template class VTKCOMMONCORE_EXPORT vtkArrayIteratorTemplate)
extern template class VTKCOMMONCORE_EXPORT
  vtkArrayIteratorTemplate<vtkStdString>;
extern template class VTKCOMMONCORE_EXPORT
  vtkArrayIteratorTemplate<vtkUnicodeString>;
extern template class VTKCOMMONCORE_EXPORT
  vtkArrayIteratorTemplate<vtkVariant>;
#ifdef _MSC_VER
#pragma warning (pop)
#endif
#endif
#endif // VTK_USE_EXTERN_TEMPLATE

Utkarsh Ayachit's avatar
ENH:  
Utkarsh Ayachit committed
130 131
#endif

132
// VTK-HeaderTest-Exclude: vtkArrayIteratorTemplate.h