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

vtkObjectList Class Reference

#include <vtkObjectList.h>

Inheritance diagram for vtkObjectList:

Inheritance graph
[legend]
Collaboration diagram for vtkObjectList:

Collaboration graph
[legend]
List of all members.

Detailed Description

A list container for objects.

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

Definition at line 31 of file vtkObjectList.h.

Public Member Functions

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

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

vtkObjectListIterator * CreateIterator (void)
 Create an iterator.

List Operations
virtual int Insert (vtkIdType position, vtkObject *item)
 Inserts an item into this sequence at the specified position.

virtual int Insert (vtkIdType position, vtkObjectList *sequence)
 Inserts copies of all items in the source sequence into this sequence at the specified position.

virtual int Insert (vtkIdType position, vtkObjectList *sequence, vtkIdType seqBeg, vtkIdType seqEnd)
 Inserts copies of the range [srcBeg ..

virtual int Assign (vtkIdType position, vtkObject *item)
 Assigns item to the specified position replacing the existant item.

virtual int PushFront (vtkObject *item)
 Add an item to the front of this sequence.

virtual int PushBack (vtkObject *item)
 Add an item to the end of this sequence.

virtual int Splice (vtkIdType dstPos, vtkObjectList *src)
 Moves all elements of the source list src into this list and inserts them at position dstPos.

virtual int Splice (vtkIdType dstPos, vtkObjectList *src, vtkIdType srcPos)
 Moves the element at position srcPos of the source list src into this list and inserts it at position dstPos.

virtual int Splice (vtkIdType dstPos, vtkObjectList *src, vtkIdType srcBeg, vtkIdType srcEnd)
 Moves the elements of the range [srcBeg, srcEnd] of the source list src into this list and inserts them at position dstPos.

virtual int Merge (vtkObjectList *src)
 The elements of list src are merged with this list.

Atypical Operations
vtkObject * At (vtkIdType position) const
 Provides access by index to the objects contained in this sequence.

Data Access Methods
vtkObject * Front (void) const
 Returns the first item in the container, or null if the container is empty.

vtkObject * Back (void) const
 Returns the last item in the container, or null if the container is empty.


Static Public Member Functions

vtkObjectList * New (void)

Protected Member Functions

 vtkObjectList (void)
 ~vtkObjectList ()

Friends

class vtkObjectListIterator

Constructor & Destructor Documentation

vtkObjectList::vtkObjectList (  void   )  [protected]
 

vtkObjectList::~vtkObjectList (   )  [protected]
 

Member Function Documentation

virtual int vtkObjectList::Assign (  vtkIdType  position,
vtkObject *  item
)  [inline, virtual]
 

Assigns item to the specified position replacing the existant item.

Returns:
true if the item can be set, otherwise false.

Definition at line 117 of file vtkObjectList.h.

vtkObject* vtkObjectList::At (  vtkIdType  position  )  const [inline, virtual]
 

Provides access by index to the objects contained in this sequence.

Parameters:
position The item index for which object should be accessed.
Returns:
the item if position is a valid index, otherwise null.

Reimplemented from vtkObjectBaseList.

Definition at line 200 of file vtkObjectList.h.

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

Returns the last item in the container, or null if the container is empty.

Reimplemented from vtkObjectBaseList.

Definition at line 217 of file vtkObjectList.h.

virtual int vtkObjectList::Copy (  vtkObjectList *  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 vtkObjectList.h.

vtkObjectListIterator* vtkObjectList::CreateIterator (  void   )  [virtual]
 

Create an iterator.

Reimplemented from vtkObjectBaseList.

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

Returns the first item in the container, or null if the container is empty.

Reimplemented from vtkObjectBaseList.

Definition at line 210 of file vtkObjectList.h.

virtual int vtkObjectList::Insert (  vtkIdType  position,
vtkObjectList *  sequence,
vtkIdType  seqBeg,
vtkIdType  seqEnd
)  [inline, virtual]
 

Inserts copies of the range [srcBeg ..

srcEnd] in the source sequence into this sequence at the specified position.

Parameters:
position An index into the sequence.
sequence A source sequence to be inserted.
seqBeg The index of the first item to copy.
seqEnd The index of the last item to copy.
Note:
Any items in the sequence at a location greater than or equal to position will be shifted by number of items in the source sequence to make room for the inserted items.

This should not invalidate iterators.

Returns:
true on success, false otherwise.

Definition at line 107 of file vtkObjectList.h.

virtual int vtkObjectList::Insert (  vtkIdType  position,
vtkObjectList *  sequence
)  [inline, virtual]
 

Inserts copies of all items in the source sequence into this sequence at the specified position.

Parameters:
position An index into the sequence.
sequence A source sequence to be inserted.
Note:
Any items in the sequence at a location greater than or equal to position will be shifted by number of items in the source sequence to make room for the inserted items.

This should not invalidate iterators.

Returns:
true on success, false otherwise.

Definition at line 86 of file vtkObjectList.h.

virtual int vtkObjectList::Insert (  vtkIdType  position,
vtkObject *  item
)  [inline, virtual]
 

Inserts an item into this sequence at the specified position.

Parameters:
position An index into the sequence.
item Data to be inserted.
Note:
Any items in the sequence at a location greater than or equal to position will be shifted by one position to make room for the inserted item.

This should not invalidate iterators.

Returns:
true on success, false otherwise.

Definition at line 68 of file vtkObjectList.h.

virtual int vtkObjectList::Merge (  vtkObjectList *  src  )  [inline, virtual]
 

The elements of list src are merged with this list.

Both lists are sorted on entry to the internal merge method and the resulting list is also sorted.

Note:
The source list src is empty after the call.
Returns:
true on success, otherwise false.

Definition at line 188 of file vtkObjectList.h.

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

Reimplemented from vtkObjectBaseList.

void vtkObjectList::PrintSelf (  ostream &  ,
vtkIndent 
)  [virtual]
 

Reimplemented from vtkObjectBaseList.

virtual int vtkObjectList::PushBack (  vtkObject *  item  )  [inline, virtual]
 

Add an item to the end of this sequence.

Parameters:
item the object to be added.

Definition at line 131 of file vtkObjectList.h.

virtual int vtkObjectList::PushFront (  vtkObject *  item  )  [inline, virtual]
 

Add an item to the front of this sequence.

Parameters:
item the object to be added.

Definition at line 124 of file vtkObjectList.h.

virtual int vtkObjectList::Splice (  vtkIdType  dstPos,
vtkObjectList *  src,
vtkIdType  srcBeg,
vtkIdType  srcEnd
)  [inline, virtual]
 

Moves the elements of the range [srcBeg, srcEnd] of the source list src into this list and inserts them at position dstPos.

Warning:
If the source list src and this list are identical, the destination position dstPos must not be within the moved range.
Note:
If the source list src and this list are identical, the elements are moved inside this list, otherwise the source list contains less elements after this operation.
Returns:
true on success, otherwise false.

Definition at line 175 of file vtkObjectList.h.

virtual int vtkObjectList::Splice (  vtkIdType  dstPos,
vtkObjectList *  src,
vtkIdType  srcPos
)  [inline, virtual]
 

Moves the element at position srcPos of the source list src into this list and inserts it at position dstPos.

Note:
If the source list src and this list are identical, the element is moved inside this list, otherwise the source list contains one less element after this operation.
Returns:
true on success, otherwise false.

Definition at line 158 of file vtkObjectList.h.

virtual int vtkObjectList::Splice (  vtkIdType  dstPos,
vtkObjectList *  src
)  [inline, virtual]
 

Moves all elements of the source list src into this list and inserts them at position dstPos.

Warning:
If the source list src and this list are identical, the internal splice method is undefined and results in failure.
Note:
The source list src is empty after the call.
Returns:
true on success, otherwise false.

Definition at line 145 of file vtkObjectList.h.

virtual int vtkObjectList::Swap (  vtkObjectList *  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 vtkObjectList.h.

vtkObjectList::vtkTypeRevisionMacro (  vtkObjectList  ,
vtkObjectBaseList 
) 
 

Friends And Related Function Documentation

friend class vtkObjectListIterator [friend]
 

Definition at line 231 of file vtkObjectList.h.

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