vtkTypedDataArray.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkTypedDataArray.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.
 
=========================================================================*/
#ifndef vtkTypedDataArray_h
#define vtkTypedDataArray_h
 
#include "vtkDataArray.h"
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkTypeTemplate.h" // For vtkTypeTemplate
#include "vtkTypeTraits.h"   // For type metadata
 
template <class Scalar> class vtkTypedDataArrayIterator;
 
template <class Scalar>
class vtkTypedDataArray :
    public vtkTypeTemplate<vtkTypedDataArray<Scalar>, vtkDataArray>
{
public:
  typedef Scalar ValueType;
 
  typedef vtkTypedDataArrayIterator<ValueType> Iterator;
 
  Iterator Begin();
 
  Iterator End();
 
  enum { VTK_DATA_TYPE = vtkTypeTraits<ValueType>::VTK_TYPE_ID };
 
  static vtkTypedDataArray<Scalar>* FastDownCast(vtkAbstractArray *source);
 
  int GetDataType();
 
  int GetDataTypeSize();
 
  virtual void SetNumberOfValues(vtkIdType num);
 
  virtual void SetTupleValue(vtkIdType i, const ValueType *t) = 0;
 
  virtual void InsertTupleValue(vtkIdType i, const ValueType *t) = 0;
 
  virtual vtkIdType InsertNextTupleValue(const ValueType *t) = 0;
 
 
  virtual vtkIdType LookupTypedValue(ValueType value) = 0;
  virtual void LookupTypedValue(ValueType value, vtkIdList *ids) = 0;
 
  virtual ValueType GetValue(vtkIdType idx) = 0;
 
  virtual ValueType& GetValueReference(vtkIdType idx) = 0;
 
  virtual void SetValue(vtkIdType idx, ValueType value) = 0;
 
  virtual void GetTupleValue(vtkIdType idx, ValueType *t) = 0;
 
  virtual vtkIdType InsertNextValue(ValueType v) = 0;
 
  virtual void InsertValue(vtkIdType idx, ValueType v) = 0;
 
  virtual int GetArrayType() { return vtkAbstractArray::TypedDataArray; }
 
protected:
  vtkTypedDataArray();
  ~vtkTypedDataArray();
 
private:
  vtkTypedDataArray(const vtkTypedDataArray &); // Not implemented.
  void operator=(const vtkTypedDataArray &);   // Not implemented.
};
 
// Included here to resolve chicken/egg issue with container/iterator:
#include "vtkTypedDataArrayIterator.h" // For iterator
 
template <class Scalar> inline
typename vtkTypedDataArray<Scalar>::Iterator vtkTypedDataArray<Scalar>::Begin()
{
  return Iterator(this, 0);
}
 
template <class Scalar> inline
typename vtkTypedDataArray<Scalar>::Iterator vtkTypedDataArray<Scalar>::End()
{
  return Iterator(this, this->MaxId + 1);
}
 
#include "vtkTypedDataArray.txx"
 
#endif //vtkTypedDataArray_h
 
// VTK-HeaderTest-Exclude: vtkTypedDataArray.h