vtkObjectVector Class Reference

#include <vtkObjectVector.h>

Inheritance diagram for vtkObjectVector:

[legend]Collaboration diagram for vtkObjectVector:

[legend]List of all members.

---

Detailed Description

A vector object for objects.

Author:

Sean McInerney

Version:

Revision

1.3

Date:

Date

2005/06/24 23:17:16

See also:

vtkObjectBaseVector vtkObject

Definition at line 31 of file vtkObjectVector.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectVector, vtkObjectBaseVector)
void	PrintSelf (ostream &, vtkIndent)
virtual int	Swap (vtkObjectVector *container)
	Swaps elements of this object with those of the specified container.
virtual int	Copy (vtkObjectVector *container)
	Copy all items from the specified container into this container.
vtkObject *	At (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, vtkObjectVector *sequence)
	Inserts copies of all items in the source sequence into this sequence at the specified position.
virtual int	Insert (vtkIdType position, vtkObjectVector *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	PushBack (vtkObject *item)
	Add an item to the end of this sequence.
virtual int	PushFront (vtkObject *item)
	Add an item to the front of this sequence.
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.
vtkObjectVectorIterator *	CreateIterator (void)
	Create an iterator.
Static Public Member Functions
vtkObjectVector *	New (void)
Protected Member Functions
	vtkObjectVector (void)
	~vtkObjectVector ()
Friends
class	vtkObjectVectorIterator

---

Constructor & Destructor Documentation

vtkObjectVector::vtkObjectVector (  void   )  [protected]

vtkObjectVector::~vtkObjectVector (   )  [protected]

---

Member Function Documentation

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

vtkObject* vtkObjectVector::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 vtkObjectBaseVector. Definition at line 59 of file vtkObjectVector.h.

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

Returns the last item in the container, or null if the container is empty. Reimplemented from vtkObjectBaseVector. Definition at line 157 of file vtkObjectVector.h.

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

vtkObjectVectorIterator* vtkObjectVector::CreateIterator (  void   )  [virtual]

Create an iterator. Reimplemented from vtkObjectBaseVector.

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

Returns the first item in the container, or null if the container is empty. Reimplemented from vtkObjectBaseVector. Definition at line 150 of file vtkObjectVector.h.

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

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

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

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

Reimplemented from vtkObjectBaseVector.

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

Reimplemented from vtkObjectBaseVector.

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

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

Add an item to the front of this sequence. Parameters: item  the object to be added. Note: This is NOT a typical vector operation. The function is implemented as an item insertion at the front of the sequence and is very inefficient compared to a list or deque. Definition at line 143 of file vtkObjectVector.h.

virtual int vtkObjectVector::Swap (  vtkObjectVector *  container  )  [inline, virtual]

Swaps elements of this object with those of the specified container. Returns: true on success, otherwise false. Definition at line 43 of file vtkObjectVector.h.

vtkObjectVector::vtkTypeRevisionMacro (  vtkObjectVector  , vtkObjectBaseVector  )

---

Friends And Related Function Documentation

friend class vtkObjectVectorIterator [friend]

Definition at line 170 of file vtkObjectVector.h.

---

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

• vtkObjectVector.h

---