vtkRandomPool.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkRandomPool.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 vtkRandomPool_h
#define vtkRandomPool_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"

class vtkRandomSequence;
class vtkDataArray;

class VTKCOMMONCORE_EXPORT vtkRandomPool : public vtkObject
{
public:

  static vtkRandomPool* New();
  vtkTypeMacro(vtkRandomPool,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetSequence(vtkRandomSequence *seq);
  vtkGetObjectMacro(Sequence,vtkRandomSequence);


  vtkSetClampMacro(Size,vtkIdType,1,VTK_ID_MAX);
  vtkGetMacro(Size,vtkIdType);


  vtkSetClampMacro(NumberOfComponents,vtkIdType,1,VTK_INT_MAX);
  vtkGetMacro(NumberOfComponents,vtkIdType);

  vtkIdType GetTotalSize() {return (this->Size*this->NumberOfComponents);}


  const double* GeneratePool();
  const double* GetPool() {return this->Pool;}
  double GetValue(vtkIdType i) {return this->Pool[(i%this->TotalSize)];}
  double GetValue(vtkIdType i, int compNum)
  {return this->Pool[(compNum + this->NumberOfComponents*i) % this->TotalSize];}


  void PopulateDataArray(vtkDataArray *da, double minRange, double maxRange);
  void PopulateDataArray(vtkDataArray *da, int compNumber,
                         double minRange, double maxRange);


  vtkSetClampMacro(ChunkSize, vtkIdType, 1000, VTK_INT_MAX);
  vtkGetMacro(ChunkSize, vtkIdType);

protected:
  vtkRandomPool();
  ~vtkRandomPool() override;

  // Keep track of last generation time
  vtkTimeStamp GenerateTime;

  // Data members to support public API
  vtkRandomSequence *Sequence;
  vtkIdType Size;
  int NumberOfComponents;
  vtkIdType ChunkSize;

  // Internal data members
  vtkIdType TotalSize;
  double *Pool;

private:
  vtkRandomPool(const vtkRandomPool&) = delete;
  void operator=(const vtkRandomPool&) = delete;
};

#endif
// VTK-HeaderTest-Exclude: vtkRandomPool.h