VTK
vtkTypedArray.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTypedArray.h
5 
6 -------------------------------------------------------------------------
7  Copyright 2008 Sandia Corporation.
8  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9  the U.S. Government retains certain rights in this software.
10 -------------------------------------------------------------------------
11 
12  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13  All rights reserved.
14  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15 
16  This software is distributed WITHOUT ANY WARRANTY; without even
17  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18  PURPOSE. See the above copyright notice for more information.
19 
20 =========================================================================*/
21 
47 #ifndef vtkTypedArray_h
48 #define vtkTypedArray_h
49 
50 #include "vtkArray.h"
51 
53 
54 template<typename T>
55 class vtkTypedArray : public vtkArray
56 {
57 public:
58  vtkTemplateTypeMacro(vtkTypedArray<T>, vtkArray)
59  typedef typename vtkArray::CoordinateT CoordinateT;
60  typedef typename vtkArray::SizeT SizeT;
61 
64 
65  void PrintSelf(ostream &os, vtkIndent indent) override;
66 
67  // vtkArray API
68  vtkVariant GetVariantValue(const vtkArrayCoordinates& coordinates) override;
69  vtkVariant GetVariantValueN(const SizeT n) override;
70  void SetVariantValue(const vtkArrayCoordinates& coordinates, const vtkVariant& value) override;
71  void SetVariantValueN(const SizeT n, const vtkVariant& value) override;
72  void CopyValue(vtkArray* source, const vtkArrayCoordinates& source_coordinates, const vtkArrayCoordinates& target_coordinates) override;
73  void CopyValue(vtkArray* source, const SizeT source_index, const vtkArrayCoordinates& target_coordinates) override;
74  void CopyValue(vtkArray* source, const vtkArrayCoordinates& source_coordinates, const SizeT target_index) override;
75 
77 
82  virtual const T& GetValue(CoordinateT i) = 0;
83  virtual const T& GetValue(CoordinateT i, CoordinateT j) = 0;
84  virtual const T& GetValue(CoordinateT i, CoordinateT j, CoordinateT k) = 0;
85  virtual const T& GetValue(const vtkArrayCoordinates& coordinates) = 0;
87 
95  virtual const T& GetValueN(const SizeT n) = 0;
96 
98 
103  virtual void SetValue(CoordinateT i, const T& value) = 0;
104  virtual void SetValue(CoordinateT i, CoordinateT j, const T& value) = 0;
105  virtual void SetValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value) = 0;
106  virtual void SetValue(const vtkArrayCoordinates& coordinates, const T& value) = 0;
108 
116  virtual void SetValueN(const SizeT n, const T& value) = 0;
117 
118 protected:
120  ~vtkTypedArray() override {}
121 
122 private:
123  vtkTypedArray(const vtkTypedArray&) = delete;
124  void operator=(const vtkTypedArray&) = delete;
125 };
126 
127 #include "vtkTypedArray.txx"
128 
129 #endif
130 
131 // VTK-HeaderTest-Exclude: vtkTypedArray.h
vtkVariant GetVariantValue(CoordinateT i)
Returns the value stored in the array at the given coordinates.
Definition: vtkArray.h:273
vtkVariant GetVariantValueN(const SizeT n) override
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
Stores coordinate into an N-way array.
virtual void SetValue(CoordinateT i, const T &value)=0
Overwrites the value stored in the array at the given coordinates.
virtual const T & GetValue(CoordinateT i)=0
Returns the value stored in the array at the given coordinates.
Abstract interface for N-dimensional arrays.
Definition: vtkArray.h:64
vtkTemplateTypeMacro(vtkTypedArray< T >, vtkArray) typedef typename vtkArray typedef vtkArray::SizeT SizeT
Definition: vtkTypedArray.h:58
vtkVariant GetVariantValue(const vtkArrayCoordinates &coordinates) override
Returns the value stored in the array at the given coordinates.
A atomic type representing the union of many types.
Definition: vtkVariant.h:65
void SetVariantValueN(const SizeT n, const vtkVariant &value) override
Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
~vtkTypedArray() override
a simple class to control print indentation
Definition: vtkIndent.h:33
void SetVariantValue(CoordinateT i, const vtkVariant &value)
Overwrites the value stored in the array at the given coordinates.
Definition: vtkArray.h:288
vtkArrayExtents::SizeT SizeT
Definition: vtkArray.h:72
void SetVariantValue(const vtkArrayCoordinates &coordinates, const vtkVariant &value) override
Overwrites the value stored in the array at the given coordinates.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void CopyValue(vtkArray *source, const vtkArrayCoordinates &source_coordinates, const vtkArrayCoordinates &target_coordinates) override
Overwrites a value with a value retrieved from another array.
virtual const T & GetValueN(const SizeT n)=0
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
Provides a type-specific interface to N-way arrays.
Definition: vtkTypedArray.h:55
virtual void SetValueN(const SizeT n, const T &value)=0
Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
vtkArrayExtents::CoordinateT CoordinateT
Definition: vtkArray.h:70