/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkDataObjectCollection.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.

=========================================================================*/
// .NAME vtkDataObjectCollection - maintain an unordered list of data objects
// .SECTION Description
// vtkDataObjectCollection is an object that creates and manipulates lists of
// data objects. See also vtkCollection and subclasses.

#ifndef vtkDataObjectCollection_h
#define vtkDataObjectCollection_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkCollection.h"

#include "vtkDataObject.h" // Needed for inline methods

class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectCollection : public vtkCollection
{
public:
  static vtkDataObjectCollection *New();
  vtkTypeMacro(vtkDataObjectCollection,vtkCollection);

  // Description:
  // Add a data object to the list.
  void AddItem(vtkDataObject *ds)
    {
      this->vtkCollection::AddItem(ds);
    }

  // Description:
  // Get the next data object in the list.
  vtkDataObject *GetNextItem()
    {
      return static_cast<vtkDataObject *>(this->GetNextItemAsObject());
    }

  // Description:
  // Get the ith data object in the list.
  vtkDataObject *GetItem(int i)
    {
      return static_cast<vtkDataObject *>(this->GetItemAsObject(i));
    }

  //BTX
  // Description:
  // Reentrant safe way to get an object in a collection. Just pass the
  // same cookie back and forth.
  vtkDataObject *GetNextDataObject(vtkCollectionSimpleIterator &cookie)
    {
      return static_cast<vtkDataObject *>(this->GetNextItemAsObject(cookie));
    }
  //ETX

protected:
  vtkDataObjectCollection() {}
  ~vtkDataObjectCollection() {}


private:
  // hide the standard AddItem from the user and the compiler.
  void AddItem(vtkObject *o) { this->vtkCollection::AddItem(o); };

private:
  vtkDataObjectCollection(const vtkDataObjectCollection&);  // Not implemented.
  void operator=(const vtkDataObjectCollection&);  // Not implemented.
};


#endif
// VTK-HeaderTest-Exclude: vtkDataObjectCollection.h
