vtkObjectBaseList.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * $Id: vtkObjectBaseList.h,v 1.4 2005/06/24 23:17:16 xpxqx Exp $
 *
 * Copyright (c) 2005 Sean McInerney
 * All rights reserved.
 *
 * See Copyright.txt or http://vtkcontainers.sourceforge.net/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.
 *
 */
#ifndef VTK_OBJECT_BASE_LIST_H_
#  define VTK_OBJECT_BASE_LIST_H_
#  include "vtkSequenceContainer.h"
#  include "vtkObjectBaseListIterator.h" // Covariant return type.

class vtkObjectBaseListInternal;

class VTK_CONTAINERS_EXPORT vtkObjectBaseList
  : public vtkSequenceContainer
{
public:
  static vtkObjectBaseList* New (void);
  vtkTypeRevisionMacro (vtkObjectBaseList, vtkSequenceContainer);
  void PrintSelf (ostream&, vtkIndent);

  virtual vtkIdType     GetSize (void) const;
  virtual int           IsEmpty (void) const;
  virtual vtkIdType     GetMaxSize (void) const;
  virtual int           Clear (void);

  virtual int           Swap (vtkObjectBaseList* container);

  virtual int           Copy (vtkObjectBaseList* container);

  virtual int                   Insert (vtkIdType       position,
                                        vtkObjectBase*  item);

  virtual int                   Insert (vtkIdType          position,
                                        vtkObjectBaseList* sequence);

  virtual int                   Insert (vtkIdType          position,
                                        vtkObjectBaseList* sequence,
                                        vtkIdType          seqBeg,
                                        vtkIdType          seqEnd);

  virtual int                   Assign (vtkIdType      position,
                                        vtkObjectBase* item);

  virtual int                   PushFront (vtkObjectBase* item);

  int                           PopFront (void);

  virtual int                   PushBack (vtkObjectBase* item);

  int                           PopBack (void);

  int                           Erase (vtkIdType position);

  int                           Erase (vtkIdType pos1, vtkIdType pos2);

  int                           Reverse (void);

  int                           Reverse (vtkIdType pos1, vtkIdType pos2);

  int                           Sort (void);

  int                           Unique (void);

  virtual int                   Splice (vtkIdType          dstPos,
                                        vtkObjectBaseList* src);

  virtual int                   Splice (vtkIdType          dstPos,
                                        vtkObjectBaseList* src,
                                        vtkIdType          srcPos);

  virtual int                   Splice (vtkIdType          dstPos,
                                        vtkObjectBaseList* src,
                                        vtkIdType          srcBeg,
                                        vtkIdType          srcEnd);

  virtual int                   Merge (vtkObjectBaseList* src);
  virtual vtkObjectBase*        At (vtkIdType position) const;

  int                           Erase (vtkObjectBase* item);

  int                           Clear (vtkObjectBase* item);

  vtkIdType                     Find (vtkObjectBase* item) const;

  int                           Rotate (vtkIdType index);

  int                           Shuffle (void);
  vtkObjectBase*                Front (void) const;

  vtkObjectBase*                Back (void) const;
  vtkObjectBaseListIterator* CreateIterator (void);

protected:
  vtkObjectBaseList (void);
  ~vtkObjectBaseList();

  void  ReportReferences (vtkGarbageCollector*);

private:
  //BTX
  vtkObjectBaseListInternal* Internal;

  friend class vtkObjectBaseListIterator;

  int Swap (vtkSequenceContainer* a)
    { return this->Swap(static_cast<vtkObjectBaseList*>(a)); }
  int Copy (vtkSequenceContainer* a)
    { return this->Copy(static_cast<vtkObjectBaseList*>(a)); }
  int Insert (vtkIdType pos, vtkSequenceContainer* a)
    { return this->Insert(pos, static_cast<vtkObjectBaseList*>(a)); }
  int Insert (vtkIdType pos, vtkSequenceContainer* a,
              vtkIdType sbeg, vtkIdType send)
    { return this->Insert(pos,static_cast<vtkObjectBaseList*>(a),sbeg,send); }
  //ETX

private:
  vtkObjectBaseList (const vtkObjectBaseList&);
  void operator= (const vtkObjectBaseList&);
};

#endif /* VTK_OBJECT_BASE_LIST_H_ */
/* 
 * End of: $Id: vtkObjectBaseList.h,v 1.4 2005/06/24 23:17:16 xpxqx Exp $.
 * 
 */

---