You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
nmWTAI-Platform/3rd/VTK7.1/include/vtkInformationIterator.h

102 lines
2.7 KiB
C

/*=========================================================================
Program: Visualization Toolkit
Module: vtkInformationIterator.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.
=========================================================================*/
/**
* @class vtkInformationIterator
* @brief Iterates over keys of an information object
*
* vtkInformationIterator can be used to iterate over the keys of an
* information object. The corresponding values can then be directly
* obtained from the information object using the keys.
*
* @sa
* vtkInformation vtkInformationKey
*/
#ifndef vtkInformationIterator_h
#define vtkInformationIterator_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
class vtkInformation;
class vtkInformationKey;
class vtkInformationIteratorInternals;
class VTKCOMMONCORE_EXPORT vtkInformationIterator : public vtkObject
{
public:
static vtkInformationIterator *New();
vtkTypeMacro(vtkInformationIterator,vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* Set/Get the information to iterator over.
*/
void SetInformation(vtkInformation*);
vtkGetObjectMacro(Information, vtkInformation);
//@}
/**
* Set the function to iterate over. The iterator
* will not hold a reference to the information object.
* Can be used to optimize certain places by avoiding
* garbage collection.
*/
void SetInformationWeak(vtkInformation*);
/**
* Move the iterator to the beginning of the collection.
*/
void InitTraversal() { this->GoToFirstItem(); }
/**
* Move the iterator to the beginning of the collection.
*/
virtual void GoToFirstItem();
/**
* Move the iterator to the next item in the collection.
*/
virtual void GoToNextItem();
/**
* Test whether the iterator is currently pointing to a valid
* item. Returns 1 for yes, 0 for no.
*/
virtual int IsDoneWithTraversal();
/**
* Get the current item. Valid only when IsDoneWithTraversal()
* returns 1.
*/
virtual vtkInformationKey* GetCurrentKey();
protected:
vtkInformationIterator();
~vtkInformationIterator() VTK_OVERRIDE;
vtkInformation* Information;
vtkInformationIteratorInternals* Internal;
bool ReferenceIsWeak;
private:
vtkInformationIterator(const vtkInformationIterator&) VTK_DELETE_FUNCTION;
void operator=(const vtkInformationIterator&) VTK_DELETE_FUNCTION;
};
#endif