VTK
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 "vtkCommonExecutionModelModule.h" // For export macro
34 #include "vtkAlgorithm.h"
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 **inputVector,
104  vtkInformationVector *outputVector) override;
106 
108 
109  vtkEnsembleSourceInternal* Internal;
110  unsigned int CurrentMember;
111 
113 
114 private:
115  vtkEnsembleSource(const vtkEnsembleSource&) = delete;
116  void operator=(const vtkEnsembleSource&) = delete;
117 };
118 
119 #endif
vtkInformationDataObjectMetaDataKey
key used to define meta-data of type vtkDataObject vtkInformationDataObjectMetaDataKey is a vtkInform...
Definition: vtkInformationDataObjectMetaDataKey.h:35
vtkEnsembleSource::CurrentMember
unsigned int CurrentMember
Definition: vtkEnsembleSource.h:110
vtkEnsembleSource::META_DATA
static vtkInformationDataObjectMetaDataKey * META_DATA()
Meta-data for the ensemble.
vtkEnsembleSource
source that manages dataset ensembles
Definition: vtkEnsembleSource.h:43
vtkEnsembleSource::~vtkEnsembleSource
~vtkEnsembleSource() override
vtkAlgorithm
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:60
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkTable
A table, which contains similar-typed columns of data.
Definition: vtkTable.h:69
vtkEnsembleSource::vtkEnsembleSource
vtkEnsembleSource()
vtkEnsembleSource::GetNumberOfMembers
unsigned int GetNumberOfMembers()
Returns the number of ensemble members.
vtkEnsembleSource::GetCurrentReader
vtkAlgorithm * GetCurrentReader(vtkInformation *)
vtkEnsembleSource::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkEnsembleSource::Internal
vtkEnsembleSourceInternal * Internal
Definition: vtkEnsembleSource.h:109
vtkEnsembleSource::RemoveAllMembers
void RemoveAllMembers()
Removes all ensemble members.
vtkEnsembleSource::UPDATE_MEMBER
static vtkInformationIntegerRequestKey * UPDATE_MEMBER()
Key used to request a particular ensemble member.
vtkEnsembleSource::New
static vtkEnsembleSource * New()
vtkInformationIntegerRequestKey
key that can used to request integer values from the pipeline vtkInformationIntegerRequestKey is a vt...
Definition: vtkInformationIntegerRequestKey.h:45
vtkAlgorithm.h
vtkEnsembleSource::MetaData
vtkTable * MetaData
Definition: vtkEnsembleSource.h:112
vtkEnsembleSource::FillOutputPortInformation
int FillOutputPortInformation(int, vtkInformation *) override
Fill the output port information objects for this algorithm.
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:35
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkEnsembleSource::DATA_MEMBER
static vtkInformationIntegerKey * DATA_MEMBER()
vtkEnsembleSource::ProcessRequest
int ProcessRequest(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
vtkEnsembleSource::SetMetaData
void SetMetaData(vtkTable *)
Set the meta-data that will be propagated downstream.
vtkEnsembleSource::AddMember
void AddMember(vtkAlgorithm *)
Add an algorithm (source) that will produce the next ensemble member.