1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
|
/*=========================================================================
Program: ParaView
Module: vtkPVCompositeDataInformationIterator.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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.
=========================================================================*/
/**
* @class vtkPVCompositeDataInformationIterator
* @brief iterator used to iterate over
* data information for a composite data set.
*
* vtkPVCompositeDataInformationIterator is an iterator used to iterate over
* data information for a composite data set.
*/
#ifndef vtkPVCompositeDataInformationIterator_h
#define vtkPVCompositeDataInformationIterator_h
#include "vtkObject.h"
#include "vtkPVClientServerCoreCoreModule.h" //needed for exports
class vtkPVDataInformation;
class VTKPVCLIENTSERVERCORECORE_EXPORT vtkPVCompositeDataInformationIterator : public vtkObject
{
public:
static vtkPVCompositeDataInformationIterator* New();
vtkTypeMacro(vtkPVCompositeDataInformationIterator, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* Get/Set the vtkPVDataInformation instance to iterate over. It is assumed
* that the argument represents the data information for a composite dataset.
*/
void SetDataInformation(vtkPVDataInformation*);
vtkGetObjectMacro(DataInformation, vtkPVDataInformation);
//@}
/**
* Initializes the traversal.
*/
void InitTraversal();
/**
* Returns true, if the iterator is finished with the traversal.
*/
bool IsDoneWithTraversal();
/**
* Goes to the next node.
*/
void GoToNextItem();
/**
* Returns the current nodes data-information. If current node is a piece
* within a multi-piece dataset, then this will return NULL.
*/
vtkPVDataInformation* GetCurrentDataInformation();
/**
* Returns the name for the current node. Name may be valid only for a child
* node. The root node has no name. Returns NULL when no name is provided.
*/
const char* GetCurrentName();
//@{
/**
* Returns the current flat index/composite index.
* This is only valid is IsDoneWithTraversal() returns false.
*/
vtkGetMacro(CurrentFlatIndex, unsigned int);
//@}
protected:
vtkPVCompositeDataInformationIterator();
~vtkPVCompositeDataInformationIterator();
unsigned int CurrentFlatIndex;
vtkPVDataInformation* DataInformation;
private:
vtkPVCompositeDataInformationIterator(
const vtkPVCompositeDataInformationIterator&) VTK_DELETE_FUNCTION;
void operator=(const vtkPVCompositeDataInformationIterator&) VTK_DELETE_FUNCTION;
class vtkInternal;
vtkInternal* Internal;
};
#endif
|