Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

vtkObjectSet Class Reference

#include <vtkObjectSet.h>

Inheritance diagram for vtkObjectSet:

Inheritance graph
[legend]
Collaboration diagram for vtkObjectSet:

Collaboration graph
[legend]
List of all members.

Detailed Description

A set container for objects.

Author:
Sean McInerney
Version:
Revision
1.4
Date:
Date
2005/06/24 23:17:16
See also:
vtkObjectBaseSet vtkObject

Definition at line 31 of file vtkObjectSet.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkObjectSet, vtkObjectBaseSet)
void PrintSelf (ostream &, vtkIndent)
virtual int Swap (vtkObjectSet *container)
 Swaps items of this container with those of the specified container.

virtual int Copy (vtkObjectSet *container)
 Copy all items from the specified container into this container.

virtual int Find (vtkObject *item) const
 Returns whether the specified item is in this set.

virtual int Insert (vtkIdType position, vtkObject *item)
 Insert an item into this set (optional position hint).

vtkObjectSetIteratorCreateIterator (void)
 Create an iterator.

Merging Methods
virtual int CreateUnion (vtkObjectSet *source, vtkObjectSet *destination)
 Merge this set with the source set so that the destination set contains all items that are either in this set, the source set, or in both sets.

virtual int CreateIntersection (vtkObjectSet *source, vtkObjectSet *destination)
 Merge this set with the source set so that the destination set contains all items that are in both sets.

virtual int CreateDifference (vtkObjectSet *source, vtkObjectSet *destination)
 Merge this set with the source set so that the destination set contains all items that are in this set, but not in the source set.

virtual int CreateSymmetricDifference (vtkObjectSet *source, vtkObjectSet *destination)
 Merge this set with the source set so that the destination set contains all items that are either in this set or in the source set, but not in both.

Data Access Methods
vtkObjectFront (void) const
 Gets the first item in the set.

vtkObjectBack (void) const
 Gets the last item in the set.


Static Public Member Functions

vtkObjectSetNew (void)

Protected Member Functions

 vtkObjectSet (void)
 ~vtkObjectSet ()

Friends

class vtkObjectSetIterator


Constructor & Destructor Documentation

vtkObjectSet::vtkObjectSet void   )  [protected]
 

vtkObjectSet::~vtkObjectSet  )  [protected]
 


Member Function Documentation

vtkObject* vtkObjectSet::Back void   )  const [inline, virtual]
 

Gets the last item in the set.

Returns:
false if the set is empty, otherwise true.
Note:
Covariant return type.

Reimplemented from vtkObjectBaseSet.

Definition at line 162 of file vtkObjectSet.h.

virtual int vtkObjectSet::Copy vtkObjectSet container  )  [inline, virtual]
 

Copy all items from the specified container into this container.

Returns:
true on success, otherwise false.

Definition at line 50 of file vtkObjectSet.h.

virtual int vtkObjectSet::CreateDifference vtkObjectSet source,
vtkObjectSet destination
[inline, virtual]
 

Merge this set with the source set so that the destination set contains all items that are in this set, but not in the source set.

Neither this set nor the source set are modified.

Note:
If this set and the source set are the same, the destination set will be empty after the call.
Warning:
The destination set must not be the same this set or the source set.
Returns:
true on success, otherwise false.

Definition at line 121 of file vtkObjectSet.h.

virtual int vtkObjectSet::CreateIntersection vtkObjectSet source,
vtkObjectSet destination
[inline, virtual]
 

Merge this set with the source set so that the destination set contains all items that are in both sets.

Neither this set nor the source set are modified.

Note:
If this set and the source set are the same, the destination set will contain a copy of this set after the call.
Warning:
The destination set must not be the same this set or the source set.
Returns:
true on success, otherwise false.

Definition at line 103 of file vtkObjectSet.h.

vtkObjectSetIterator* vtkObjectSet::CreateIterator void   )  [virtual]
 

Create an iterator.

Reimplemented from vtkObjectBaseSet.

virtual int vtkObjectSet::CreateSymmetricDifference vtkObjectSet source,
vtkObjectSet destination
[inline, virtual]
 

Merge this set with the source set so that the destination set contains all items that are either in this set or in the source set, but not in both.

Neither this set nor the source set are modified.

Note:
If this set and the source set are the same, the destination set will be empty after the call.
Warning:
The destination set must not be the same this set or the source set.
Returns:
true on success, otherwise false.

Definition at line 140 of file vtkObjectSet.h.

virtual int vtkObjectSet::CreateUnion vtkObjectSet source,
vtkObjectSet destination
[inline, virtual]
 

Merge this set with the source set so that the destination set contains all items that are either in this set, the source set, or in both sets.

Neither this set nor the source set are modified.

Note:
If this set and the source set are the same, the destination set will contain a copy of this set after the call.
Warning:
The destination set must not be the same this set or the source set.
Returns:
true on success, otherwise false.

Definition at line 85 of file vtkObjectSet.h.

virtual int vtkObjectSet::Find vtkObject item  )  const [inline, virtual]
 

Returns whether the specified item is in this set.

Returns:
true if found, false otherwise.

Definition at line 57 of file vtkObjectSet.h.

vtkObject* vtkObjectSet::Front void   )  const [inline, virtual]
 

Gets the first item in the set.

Returns:
false if the set is empty, otherwise true.
Note:
Covariant return type.

Reimplemented from vtkObjectBaseSet.

Definition at line 153 of file vtkObjectSet.h.

virtual int vtkObjectSet::Insert vtkIdType  position,
vtkObject item
[inline, virtual]
 

Insert an item into this set (optional position hint).

Returns:
true on success, false otherwise.

Definition at line 64 of file vtkObjectSet.h.

vtkObjectSet* vtkObjectSet::New void   )  [static]
 

Reimplemented from vtkObjectBaseSet.

void vtkObjectSet::PrintSelf ostream &  ,
vtkIndent 
[virtual]
 

Reimplemented from vtkObjectBaseSet.

virtual int vtkObjectSet::Swap vtkObjectSet container  )  [inline, virtual]
 

Swaps items of this container with those of the specified container.

Returns:
true on success, otherwise false.

Definition at line 43 of file vtkObjectSet.h.

vtkObjectSet::vtkTypeRevisionMacro vtkObjectSet  ,
vtkObjectBaseSet 
 


Friends And Related Function Documentation

friend class vtkObjectSetIterator [friend]
 

Definition at line 175 of file vtkObjectSet.h.


The documentation for this class was generated from the following file:
Generated on Thu Jul 14 14:40:06 2005 for vtkContainers by doxygen 1.3.6