VTK  9.2.6
vtkEnsembleSource.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkEnsembleSource.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
30 #ifndef vtkEnsembleSource_h
31 #define vtkEnsembleSource_h
32 
33 #include "vtkAlgorithm.h"
34 #include "vtkCommonExecutionModelModule.h" // For export macro
35 
36 struct vtkEnsembleSourceInternal;
37 class vtkTable;
41 
42 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkEnsembleSource : public vtkAlgorithm
43 {
44 public:
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
55 
60 
64  unsigned int GetNumberOfMembers();
65 
67 
73  vtkSetMacro(CurrentMember, unsigned int);
74  vtkGetMacro(CurrentMember, unsigned int);
76 
83 
88 
93 
94 protected:
96  ~vtkEnsembleSource() override;
97 
99 
100  friend class vtkInformationEnsembleMemberRequestKey;
101 
103  vtkInformationVector* outputVector) override;
105 
107 
108  vtkEnsembleSourceInternal* Internal;
109  unsigned int CurrentMember;
110 
112 
113 private:
114  vtkEnsembleSource(const vtkEnsembleSource&) = delete;
115  void operator=(const vtkEnsembleSource&) = delete;
116 };
117 
118 #endif
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:122
source that manages dataset ensembles
static vtkInformationIntegerRequestKey * UPDATE_MEMBER()
Key used to request a particular ensemble member.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
unsigned int GetNumberOfMembers()
Returns the number of ensemble members.
unsigned int CurrentMember
static vtkInformationIntegerKey * DATA_MEMBER()
int FillOutputPortInformation(int, vtkInformation *) override
Fill the output port information objects for this algorithm.
static vtkInformationDataObjectMetaDataKey * META_DATA()
Meta-data for the ensemble.
vtkAlgorithm * GetCurrentReader(vtkInformation *)
void AddMember(vtkAlgorithm *)
Add an algorithm (source) that will produce the next ensemble member.
static vtkEnsembleSource * New()
void SetMetaData(vtkTable *)
Set the meta-data that will be propagated downstream.
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
vtkEnsembleSourceInternal * Internal
~vtkEnsembleSource() override
void RemoveAllMembers()
Removes all ensemble members.
a simple class to control print indentation
Definition: vtkIndent.h:119
key used to define meta-data of type vtkDataObject vtkInformationDataObjectMetaDataKey is a vtkInform...
Key for integer values in vtkInformation.
key that can used to request integer values from the pipeline vtkInformationIntegerRequestKey is a vt...
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:183
int vtkTypeBool
Definition: vtkABI.h:69