VTK  9.1.20211024
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:
60  typedef typename vtkArray::SizeT SizeT;
61 
64 
65  inline void PrintSelf(ostream& os, vtkIndent indent) override;
66 
67  // vtkArray API
68  inline vtkVariant GetVariantValue(const vtkArrayCoordinates& coordinates) override;
69  inline vtkVariant GetVariantValueN(const SizeT n) override;
70  inline void SetVariantValue(
71  const vtkArrayCoordinates& coordinates, const vtkVariant& value) override;
72  inline void SetVariantValueN(const SizeT n, const vtkVariant& value) override;
73  inline void CopyValue(vtkArray* source, const vtkArrayCoordinates& source_coordinates,
74  const vtkArrayCoordinates& target_coordinates) override;
75  inline void CopyValue(vtkArray* source, const SizeT source_index,
76  const vtkArrayCoordinates& target_coordinates) override;
77  inline void CopyValue(vtkArray* source, const vtkArrayCoordinates& source_coordinates,
78  const SizeT target_index) override;
79 
81 
86  virtual const T& GetValue(CoordinateT i) = 0;
87  virtual const T& GetValue(CoordinateT i, CoordinateT j) = 0;
88  virtual const T& GetValue(CoordinateT i, CoordinateT j, CoordinateT k) = 0;
89  virtual const T& GetValue(const vtkArrayCoordinates& coordinates) = 0;
91 
99  virtual const T& GetValueN(const SizeT n) = 0;
100 
102 
107  virtual void SetValue(CoordinateT i, const T& value) = 0;
108  virtual void SetValue(CoordinateT i, CoordinateT j, const T& value) = 0;
109  virtual void SetValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value) = 0;
110  virtual void SetValue(const vtkArrayCoordinates& coordinates, const T& value) = 0;
112 
120  virtual void SetValueN(const SizeT n, const T& value) = 0;
121 
122 protected:
123  vtkTypedArray() = default;
124  ~vtkTypedArray() override = default;
125 
126 private:
127  vtkTypedArray(const vtkTypedArray&) = delete;
128  void operator=(const vtkTypedArray&) = delete;
129 };
130 
131 #include "vtkTypedArray.txx"
132 
133 #endif
134 
135 // VTK-HeaderTest-Exclude: vtkTypedArray.h
Stores coordinate into an N-way array.
Abstract interface for N-dimensional arrays.
Definition: vtkArray.h:65
void SetVariantValue(CoordinateT i, const vtkVariant &value)
Overwrites the value stored in the array at the given coordinates.
Definition: vtkArray.h:291
vtkArrayExtents::SizeT SizeT
Definition: vtkArray.h:72
vtkArrayExtents::CoordinateT CoordinateT
Definition: vtkArray.h:70
vtkVariant GetVariantValue(CoordinateT i)
Returns the value stored in the array at the given coordinates.
Definition: vtkArray.h:276
a simple class to control print indentation
Definition: vtkIndent.h:113
Provides a type-specific interface to N-way arrays.
Definition: vtkTypedArray.h:56
vtkVariant GetVariantValue(const vtkArrayCoordinates &coordinates) override
Returns the value stored in the array at the given coordinates.
virtual void SetValue(CoordinateT i, CoordinateT j, const T &value)=0
Overwrites the value stored in the array at the given coordinates.
virtual void SetValue(CoordinateT i, const T &value)=0
Overwrites the value stored in the array at the given coordinates.
vtkTemplateTypeMacro(vtkTypedArray< T >, vtkArray)
vtkArray::CoordinateT CoordinateT
Definition: vtkTypedArray.h:59
~vtkTypedArray() override=default
vtkVariant GetVariantValueN(const SizeT n) override
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
void CopyValue(vtkArray *source, const SizeT source_index, 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()).
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()).
void CopyValue(vtkArray *source, const vtkArrayCoordinates &source_coordinates, const SizeT target_index) override
Overwrites a value with a value retrieved from another array.
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()).
virtual void SetValue(const vtkArrayCoordinates &coordinates, 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.
vtkTypedArray()=default
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 & GetValue(CoordinateT i, CoordinateT j)=0
Returns the value stored in the array at the given coordinates.
virtual void SetValue(CoordinateT i, CoordinateT j, CoordinateT k, const T &value)=0
Overwrites the value stored in the array at the given coordinates.
virtual const T & GetValue(const vtkArrayCoordinates &coordinates)=0
Returns the value stored in the array at the given coordinates.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkArray::SizeT SizeT
Definition: vtkTypedArray.h:60
virtual const T & GetValue(CoordinateT i, CoordinateT j, CoordinateT k)=0
Returns the value stored in the array at the given coordinates.
void SetVariantValue(const vtkArrayCoordinates &coordinates, const vtkVariant &value) override
Overwrites the value stored in the array at the given coordinates.
A atomic type representing the union of many types.
Definition: vtkVariant.h:155
@ value
Definition: vtkX3D.h:226
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)