vtkObjectVector Class Reference

#include <vtkObjectVector.h>

Inheritance diagram for vtkObjectVector:

[legend]Collaboration diagram for vtkObjectVector:

[legend]List of all members.

---

Detailed Description

A vector sequence object for objects.

Calls Register when objects are inserted into the sequence and UnRegister when the object is removed.

Author:

Sean McInerney

Version:

Revision

1.2

Date:

Date

2004/06/03 18:58:29

See also:

vtkObjectBaseVector vtkObject

Definition at line 36 of file vtkObjectVector.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectVector, vtkObjectBaseVector)
virtual int	Swap (vtkObjectVector *container)
	Swaps elements of this object with those of the specified container.
virtual vtkObject *	At (vtkIdType position) const
	Provides access to the data contained in this vector.
virtual vtkIdType	Find (const vtkObject *object) const
	Find an object in the vector.
virtual vtkIdType	Find (const vtkObject *object, CompareFunction comparison) const
	Find an object in the vector using a comparison routine.
virtual int	IsPresent (const vtkObject *object) const
	Find an object in the vector.
virtual int	Insert (vtkIdType position, vtkObject *object)
	Inserts a pointer to an object into before the specified position.
virtual int	Insert (vtkIdType position, vtkObjectVector *sequence)
	Insert a sequence at the specific position in this vector.
virtual int	PushFront (vtkObject *object)
	Add a pointer to an object to the front of this vector.
virtual int	PushBack (vtkObject *object)
	Add a pointer to an object to the end of this vector.
virtual int	PushBack (vtkObjectVector *sequence)
	Append a sequence to the end of this vector.
virtual int	Assign (vtkIdType position, vtkObject *object)
	Sets the object at the specific position to a new value.
vtkObjectVectorIterator *	CreateIterator (void)
	Create an iterator.
Data Access Methods
virtual vtkObject *	Front (void) const
	Get a read/write pointer to the first object in the vector.
virtual vtkObject *	Back (void) const
	Get a read/write pointer to the last object in the vector.
Static Public Member Functions
vtkObjectVector *	New (void)
Protected Member Functions
	vtkObjectVector (void)
	~vtkObjectVector ()

---

Constructor & Destructor Documentation

vtkObjectVector::vtkObjectVector (  void   )  [inline, protected]

Definition at line 183 of file vtkObjectVector.h.

vtkObjectVector::~vtkObjectVector (   )  [inline, protected]

Definition at line 184 of file vtkObjectVector.h.

---

Member Function Documentation

virtual int vtkObjectVector::Assign (  vtkIdType  position, vtkObject *  object )  [inline, virtual]

Sets the object at the specific position to a new value. Returns: true if the item can be set, otherwise false. Definition at line 156 of file vtkObjectVector.h.

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

Provides access to the data contained in this vector. Parameters: position  The element index for which data should be accessed. Returns: A Read/write pointer to the object if position is a valid index, otherwise null. Reimplemented from vtkObjectBaseVector. Reimplemented in vtkExtensionsObjectVector. Definition at line 57 of file vtkObjectVector.h.

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

Get a read/write pointer to the last object in the vector. Returns: null if the vector is empty, otherwise returns a pointer to an object. Reimplemented from vtkObjectBaseVector. Reimplemented in vtkExtensionsObjectVector. Definition at line 175 of file vtkObjectVector.h.

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

Create an iterator. Reimplemented from vtkObjectBaseVector. Reimplemented in vtkExtensionsObjectVector.

virtual vtkIdType vtkObjectVector::Find (  const vtkObject *  object, CompareFunction  comparison )  const [inline, virtual]

Find an object in the vector using a comparison routine. Returns: true if it was found, false if it was not found. Definition at line 72 of file vtkObjectVector.h.

virtual vtkIdType vtkObjectVector::Find (  const vtkObject *  object  )  const [inline, virtual]

Find an object in the vector. Returns: The position if it was found, -1 if it was not found. Definition at line 64 of file vtkObjectVector.h.

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

Get a read/write pointer to the first object in the vector. Returns: null if the vector is empty, otherwise returns a pointer to an object. Reimplemented from vtkObjectBaseVector. Reimplemented in vtkExtensionsObjectVector. Definition at line 167 of file vtkObjectVector.h.

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

Insert a sequence at the specific position in this vector. Any objects in the vector at a location greater than position will be shifted by the size of the sequence to make room for the inserted elements. Parameters: position  An index into the vector. sequence  The vector containing data to be inserted. Warning: This can not be used with SetCapacity() because there will be no room for the additional elements. Returns: true on success, false otherwise. Definition at line 115 of file vtkObjectVector.h.

virtual int vtkObjectVector::Insert (  vtkIdType  position, vtkObject *  object )  [inline, virtual]

Inserts a pointer to an object into before the specified position. Any objects in the vector at a location greater than position will be shifted by one position to make room for the inserted object. Parameters: position  An index into the vector. object  Data to be inserted. Warning: This can not be used with SetCapacity() because there will be no room for the additional object. Returns: true on success, false otherwise. Definition at line 97 of file vtkObjectVector.h.

virtual int vtkObjectVector::IsPresent (  const vtkObject *  object  )  const [inline, virtual]

Find an object in the vector. Returns: true if it was found, otherwise false. Definition at line 81 of file vtkObjectVector.h.

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

Reimplemented from vtkObjectBaseVector. Reimplemented in vtkExtensionsObjectVector.

virtual int vtkObjectVector::PushBack (  vtkObjectVector *  sequence  )  [inline, virtual]

Append a sequence to the end of this vector. Parameters: sequence  The vector containing data to be appended. Warning: This can not be used with SetCapacity() because there will be no room for the additional elements. Returns: true on success, false otherwise. Definition at line 149 of file vtkObjectVector.h.

virtual int vtkObjectVector::PushBack (  vtkObject *  object  )  [inline, virtual]

Add a pointer to an object to the end of this vector. Parameters: object  Data to be added. This is a typical stack operation. The function creates an element at the end of the vector and assigns the given pointer to it. Definition at line 137 of file vtkObjectVector.h.

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

Add a pointer to an object to the front of this vector. Parameters: object  Data to be added. This is a typical stack operation. The function creates an element at the front of the vector and assigns the given data to it. Definition at line 126 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 47 of file vtkObjectVector.h.

vtkObjectVector::vtkTypeRevisionMacro (  vtkObjectVector  , vtkObjectBaseVector  )

---

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

• vtkObjectVector.h

---