source that manages dataset ensembles More...
#include <vtkEnsembleSource.h>
Detailed Description
source that manages dataset ensembles
vtkEnsembleSource manages a collection of data sources in order to represent a dataset ensemble. It has the ability to provide meta-data about the ensemble in the form of a table, using the META_DATA key as well as accept a pipeline request using the UPDATE_MEMBER key. Note that it is expected that all ensemble members produce data of the same type.
Definition at line 41 of file vtkEnsembleSource.h.
Member Typedef Documentation
Reimplemented from vtkAlgorithm.
Definition at line 45 of file vtkEnsembleSource.h.
Constructor & Destructor Documentation
| vtkEnsembleSource::vtkEnsembleSource | ( | ) | [protected] |
| vtkEnsembleSource::~vtkEnsembleSource | ( | ) | [protected] |
Member Function Documentation
| static vtkEnsembleSource* vtkEnsembleSource::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
| static int vtkEnsembleSource::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkAlgorithm.
| virtual int vtkEnsembleSource::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkAlgorithm.
| static vtkEnsembleSource* vtkEnsembleSource::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkAlgorithm.
| virtual vtkObjectBase* vtkEnsembleSource::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkAlgorithm.
| vtkEnsembleSource* vtkEnsembleSource::NewInstance | ( | ) | const |
Reimplemented from vtkAlgorithm.
| void vtkEnsembleSource::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkAlgorithm.
| void vtkEnsembleSource::AddMember | ( | vtkAlgorithm * | ) |
Add an algorithm (source) that will produce the next ensemble member. This algorithm will be passed the REQUEST_INFORMATION, REQUEST_UPDATE_EXTENT and REQUEST_DATA pipeline passes for execution.
| void vtkEnsembleSource::RemoveAllMembers | ( | ) |
Removes all ensemble members.
| unsigned int vtkEnsembleSource::GetNumberOfMembers | ( | ) |
Returns the number of ensemble members.
| virtual void vtkEnsembleSource::SetCurrentMember | ( | unsigned | int | ) | [virtual] |
Set/Get the current ensemble member to process. Note that this data member will not be used if the UPDATE_MEMBER key is present in the pipeline. Also, this data member may be removed in the future. Unless it is absolutely necessary to use this data member, use the UPDATE_MEMBER key instead.
| virtual unsigned int vtkEnsembleSource::GetCurrentMember | ( | ) | [virtual] |
Set/Get the current ensemble member to process. Note that this data member will not be used if the UPDATE_MEMBER key is present in the pipeline. Also, this data member may be removed in the future. Unless it is absolutely necessary to use this data member, use the UPDATE_MEMBER key instead.
| void vtkEnsembleSource::SetMetaData | ( | vtkTable * | ) |
Set the meta-data that will be propagated downstream. Make sure that this table has as many rows as the ensemble members and the meta-data for each row matches the corresponding ensemble source.
| static vtkInformationDataObjectMetaDataKey* vtkEnsembleSource::META_DATA | ( | ) | [static] |
Meta-data for the ensemble. This is set with SetMetaData.
| static vtkInformationIntegerRequestKey* vtkEnsembleSource::UPDATE_MEMBER | ( | ) | [static] |
Key used to request a particular ensemble member.
| static vtkInformationIntegerKey* vtkEnsembleSource::DATA_MEMBER | ( | ) | [static, protected] |
| virtual int vtkEnsembleSource::ProcessRequest | ( | vtkInformation * | request, |
| vtkInformationVector ** | inInfo, | ||
| vtkInformationVector * | outInfo | ||
| ) | [protected, virtual] |
Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs. A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest. An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest. It returns the boolean status of the pipeline (false means failure).
Reimplemented from vtkAlgorithm.
| virtual int vtkEnsembleSource::FillOutputPortInformation | ( | int | port, |
| vtkInformation * | info | ||
| ) | [protected, virtual] |
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkAlgorithm.
| vtkAlgorithm* vtkEnsembleSource::GetCurrentReader | ( | vtkInformation * | ) | [protected] |
Friends And Related Function Documentation
friend class vtkInformationEnsembleMemberRequestKey [friend] |
Definition at line 86 of file vtkEnsembleSource.h.
Member Data Documentation
vtkEnsembleSourceInternal* vtkEnsembleSource::Internal [protected] |
Definition at line 95 of file vtkEnsembleSource.h.
unsigned int vtkEnsembleSource::CurrentMember [protected] |
Definition at line 96 of file vtkEnsembleSource.h.
vtkTable* vtkEnsembleSource::MetaData [protected] |
Definition at line 98 of file vtkEnsembleSource.h.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Common/ExecutionModel/vtkEnsembleSource.h
