vtkObjectBaseSet Class Reference

#include <vtkObjectBaseSet.h>

Inheritance diagram for vtkObjectBaseSet:

[legend]Collaboration diagram for vtkObjectBaseSet:

[legend]List of all members.

---

Detailed Description

A set object for objects.

Calls Register when objects are inserted into the set and UnRegister when the object is erased.

Author:

Sean McInerney

Version:

Revision

1.5

Date:

Date

2004/06/03 18:58:28

See also:

vtkObjectBase

Definition at line 38 of file vtkObjectBaseSet.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectBaseSet, vtkContainer)
vtkIdType	GetSize (void) const
	Returns the number of elements in the set.
int	IsEmpty (void) const
	Returns true if the set is empty.
vtkIdType	GetMaxSize (void) const
	Returns the maximum size of the set.
void	Clear (void)
	Erases ALL elements (makes the set empty).
virtual int	Swap (vtkObjectBaseSet *container)
	Swaps elements of this object with those of the specified container.
vtkIdType	GetCapacity (void) const
	Returns the maximum number of elements allowed in the set.
virtual int	Find (vtkObjectBase *object) const
	Returns whether the specified object is in this set.
virtual int	Insert (vtkObjectBase *object)
	Insert an object into this set.
virtual int	Erase (vtkObjectBase *object)
	Erases an object from this set.
vtkObjectBaseSetIterator *	CreateIterator (void)
	Create an iterator.
Data Access Methods
vtkObjectBase *	Front (void) const
	Gets the first object in the set.
vtkObjectBase *	Back (void) const
	Gets the last object in the set.
Static Public Member Functions
vtkObjectBaseSet *	New (void)
Protected Member Functions
	vtkObjectBaseSet (void)
	~vtkObjectBaseSet ()

---

Constructor & Destructor Documentation

vtkObjectBaseSet::vtkObjectBaseSet (  void   )  [protected]

vtkObjectBaseSet::~vtkObjectBaseSet (   )  [protected]

---

Member Function Documentation

vtkObjectBase* vtkObjectBaseSet::Back (  void   )  const [virtual]

Gets the last object in the set. Returns: false if the set is empty, otherwise true. Reimplemented from vtkContainer. Reimplemented in vtkExtensionsObjectSet, and vtkObjectSet.

void vtkObjectBaseSet::Clear (  void   )  [virtual]

Erases ALL elements (makes the set empty). Implements vtkContainer.

vtkObjectBaseSetIterator* vtkObjectBaseSet::CreateIterator (  void   )  [virtual]

Create an iterator. Implements vtkContainer. Reimplemented in vtkExtensionsObjectSet, and vtkObjectSet.

virtual int vtkObjectBaseSet::Erase (  vtkObjectBase *  object  )  [virtual]

Erases an object from this set. Returns: true on success, false otherwise.

virtual int vtkObjectBaseSet::Find (  vtkObjectBase *  object  )  const [virtual]

Returns whether the specified object is in this set. Returns: true if found, false otherwise.

vtkObjectBase* vtkObjectBaseSet::Front (  void   )  const [virtual]

Gets the first object in the set. Returns: false if the set is empty, otherwise true. Reimplemented from vtkContainer. Reimplemented in vtkExtensionsObjectSet, and vtkObjectSet.

vtkIdType vtkObjectBaseSet::GetCapacity (  void   )  const

Returns the maximum number of elements allowed in the set.

vtkIdType vtkObjectBaseSet::GetMaxSize (  void   )  const [virtual]

Returns the maximum size of the set. Reimplemented from vtkContainer.

vtkIdType vtkObjectBaseSet::GetSize (  void   )  const [virtual]

Returns the number of elements in the set. Reimplemented from vtkContainer.

virtual int vtkObjectBaseSet::Insert (  vtkObjectBase *  object  )  [virtual]

Insert an object into this set. Returns: true on success, false otherwise.

int vtkObjectBaseSet::IsEmpty (  void   )  const [virtual]

Returns true if the set is empty. Reimplemented from vtkContainer.

vtkObjectBaseSet* vtkObjectBaseSet::New (  void   )  [static]

Reimplemented from vtkExtensionsObject. Reimplemented in vtkExtensionsObjectSet, and vtkObjectSet.

virtual int vtkObjectBaseSet::Swap (  vtkObjectBaseSet *  container  )  [virtual]

Swaps elements of this object with those of the specified container. Returns: true on success, otherwise false.

vtkObjectBaseSet::vtkTypeRevisionMacro (  vtkObjectBaseSet  , vtkContainer  )

---

The documentation for this class was generated from the following file:

• vtkObjectBaseSet.h

---