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

vtkObjectDeque Class Reference

#include <vtkObjectDeque.h>

Inheritance diagram for vtkObjectDeque:

Inheritance graph
[legend]
Collaboration diagram for vtkObjectDeque:

Collaboration graph
[legend]
List of all members.

Detailed Description

A deque container for objects.

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

Definition at line 31 of file vtkObjectDeque.h.

Public Member Functions

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

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

vtkObjectAt (vtkIdType position) const
 Provides access by index to the objects contained in this sequence.

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

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

virtual int Insert (vtkIdType position, vtkObjectDeque *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.

vtkObjectFront (void) const
 Returns the first item in the container, or null if the container is empty.

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

vtkObjectDequeIteratorCreateIterator (void)
 Create an iterator.


Static Public Member Functions

vtkObjectDequeNew (void)

Protected Member Functions

 vtkObjectDeque (void)
 ~vtkObjectDeque ()

Friends

class vtkObjectDequeIterator


Constructor & Destructor Documentation

vtkObjectDeque::vtkObjectDeque void   )  [protected]
 

vtkObjectDeque::~vtkObjectDeque  )  [protected]
 


Member Function Documentation

virtual int vtkObjectDeque::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 124 of file vtkObjectDeque.h.

vtkObject* vtkObjectDeque::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 vtkObjectBaseDeque.

Definition at line 59 of file vtkObjectDeque.h.

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

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

Reimplemented from vtkObjectBaseDeque.

Definition at line 152 of file vtkObjectDeque.h.

virtual int vtkObjectDeque::Copy vtkObjectDeque 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 vtkObjectDeque.h.

vtkObjectDequeIterator* vtkObjectDeque::CreateIterator void   )  [virtual]
 

Create an iterator.

Reimplemented from vtkObjectBaseDeque.

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

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

Reimplemented from vtkObjectBaseDeque.

Definition at line 145 of file vtkObjectDeque.h.

virtual int vtkObjectDeque::Insert vtkIdType  position,
vtkObjectDeque 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.
Warning:
This may invalidate iterators.
Returns:
true on success, false otherwise.

Definition at line 114 of file vtkObjectDeque.h.

virtual int vtkObjectDeque::Insert vtkIdType  position,
vtkObjectDeque 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.
Warning:
This may invalidate iterators.
Returns:
true on success, false otherwise.

Definition at line 93 of file vtkObjectDeque.h.

virtual int vtkObjectDeque::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.
Warning:
This may invalidate iterators.
Returns:
true on success, false otherwise.

Definition at line 75 of file vtkObjectDeque.h.

vtkObjectDeque* vtkObjectDeque::New void   )  [static]
 

Reimplemented from vtkObjectBaseDeque.

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

Reimplemented from vtkObjectBaseDeque.

virtual int vtkObjectDeque::PushBack vtkObject item  )  [inline, virtual]
 

Add an item to the end of this sequence.

Parameters:
item the object to be added.

Definition at line 138 of file vtkObjectDeque.h.

virtual int vtkObjectDeque::PushFront vtkObject item  )  [inline, virtual]
 

Add an item to the front of this sequence.

Parameters:
item the object to be added.

Definition at line 131 of file vtkObjectDeque.h.

virtual int vtkObjectDeque::Swap vtkObjectDeque 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 vtkObjectDeque.h.

vtkObjectDeque::vtkTypeRevisionMacro vtkObjectDeque  ,
vtkObjectBaseDeque 
 


Friends And Related Function Documentation

friend class vtkObjectDequeIterator [friend]
 

Definition at line 165 of file vtkObjectDeque.h.


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