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 "vtkGenericDataArray.h"

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkTypeTraits.h"   // For type metadata

template <class Scalar> class vtkTypedDataArrayIterator;

template <class Scalar>
class vtkTypedDataArray :
    public vtkGenericDataArray<vtkTypedDataArray<Scalar>, Scalar>
{
  typedef vtkGenericDataArray<vtkTypedDataArray<Scalar>, Scalar>
    GenericDataArrayType;
public:
  vtkTemplateTypeMacro(vtkTypedDataArray<Scalar>, GenericDataArrayType)
  typedef typename Superclass::ValueType 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() VTK_OVERRIDE;

  int GetDataTypeSize() VTK_OVERRIDE;

  void SetNumberOfValues(vtkIdType num) VTK_OVERRIDE;

  virtual void SetTypedTuple(vtkIdType i, const ValueType *t) = 0;

  virtual void InsertTypedTuple(vtkIdType i, const ValueType *t) = 0;

  virtual vtkIdType InsertNextTypedTuple(const ValueType *t) = 0;

  virtual ValueType GetValue(vtkIdType idx) const = 0;

  virtual ValueType& GetValueReference(vtkIdType idx) = 0;

  virtual void SetValue(vtkIdType idx, ValueType value) = 0;

  virtual void GetTypedTuple(vtkIdType idx, ValueType *t) const = 0;

  virtual vtkIdType InsertNextValue(ValueType v) = 0;

  virtual void InsertValue(vtkIdType idx, ValueType v) = 0;

  virtual ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const;
  virtual void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType v);

  int GetArrayType() VTK_OVERRIDE { return vtkAbstractArray::TypedDataArray; }

  // Reintroduced as pure virtual since the base vtkGenericDataArray method
  // requires new allocation/resize APIs, though existing MappedDataArrays
  // would just use the vtkDataArray-level virtuals.
  virtual int Allocate(vtkIdType size, vtkIdType ext = 1000) = 0;
  virtual int Resize(vtkIdType numTuples) = 0;

protected:
  vtkTypedDataArray();
  ~vtkTypedDataArray();

  virtual bool AllocateTuples(vtkIdType numTuples);

  virtual bool ReallocateTuples(vtkIdType numTuples);

private:
  vtkTypedDataArray(const vtkTypedDataArray &) VTK_DELETE_FUNCTION;
  void operator=(const vtkTypedDataArray &) VTK_DELETE_FUNCTION;

  friend class vtkGenericDataArray<vtkTypedDataArray<Scalar>, Scalar>;
};

// Declare vtkArrayDownCast implementations for typed containers:
vtkArrayDownCast_TemplateFastCastMacro(vtkTypedDataArray)

// 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