Key for vtkObjectBase vector values. More...

#include <vtkInformationObjectBaseVectorKey.h>

Inheritance diagram for vtkInformationObjectBaseVectorKey:

Collaboration diagram for vtkInformationObjectBaseVectorKey:

Public Types
typedef vtkInformationKey	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkInformationObjectBaseVectorKey *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	Clear (vtkInformation *info)
void	Resize (vtkInformation *info, int n)
void	Append (vtkInformation info, vtkObjectBase value)
void	Set (vtkInformation info, vtkObjectBase value, int i)
vtkObjectBase *	Get (vtkInformation *info, int idx)
virtual void	ShallowCopy (vtkInformation from, vtkInformation to)
virtual void	Print (ostream &os, vtkInformation *info)

	vtkInformationObjectBaseVectorKey (const char name, const char location, const char *requiredClass=0)
	~vtkInformationObjectBaseVectorKey ()

int	Size (vtkInformation *info)
int	Length (vtkInformation *info)

void	SetRange (vtkInformation info, vtkObjectBase *source, int from, int to, int n)

void	GetRange (vtkInformation info, vtkObjectBase *dest, int from, int to, int n)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInformationObjectBaseVectorKey *	SafeDownCast (vtkObjectBase *o)

static vtkInformationObjectBaseVectorKey *	MakeKey (const char name, const char location, const char *requiredClass=0)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
Protected Attributes
const char *	RequiredClass

Detailed Description

Key for vtkObjectBase vector values.

vtkInformationObjectBaseVectorKey is used to represent keys for double vector values in vtkInformation.h. NOTE the interface in this key differs from that in other similar keys because of our internal use of smart pointers.

Definition at line 33 of file vtkInformationObjectBaseVectorKey.h.

Member Typedef Documentation

typedef vtkInformationKey vtkInformationObjectBaseVectorKey::Superclass

Reimplemented from vtkInformationKey.

Definition at line 36 of file vtkInformationObjectBaseVectorKey.h.

Constructor & Destructor Documentation

vtkInformationObjectBaseVectorKey::vtkInformationObjectBaseVectorKey	(	const char *	name,
		const char *	location,
		const char *	requiredClass = `0`
	)

The name of the static instance and the class in which it is defined(location) should be passed to the constructor. Providing "requiredClass" name one can insure that only objects of type "requiredClass" are stored in vectors associated with the instance of this key type created. These should be string literals as they are not coppied.

vtkInformationObjectBaseVectorKey::~vtkInformationObjectBaseVectorKey ( )

The name of the static instance and the class in which it is defined(location) should be passed to the constructor. Providing "requiredClass" name one can insure that only objects of type "requiredClass" are stored in vectors associated with the instance of this key type created. These should be string literals as they are not coppied.

Member Function Documentation

static int vtkInformationObjectBaseVectorKey::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInformationKey.

virtual int vtkInformationObjectBaseVectorKey::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInformationKey.

static vtkInformationObjectBaseVectorKey* vtkInformationObjectBaseVectorKey::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkInformationKey.

virtual vtkObjectBase* vtkInformationObjectBaseVectorKey::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkInformationKey.

vtkInformationObjectBaseVectorKey* vtkInformationObjectBaseVectorKey::NewInstance ( ) const

Reimplemented from vtkInformationKey.

void vtkInformationObjectBaseVectorKey::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkInformationKey.

static vtkInformationObjectBaseVectorKey* vtkInformationObjectBaseVectorKey::MakeKey	(	const char *	name,
		const char *	location,
		const char *	requiredClass = `0`
	)		`[inline, static]`

This method simply returns a new vtkInformationObjectBaseVectorKey, given a name, location and optionally a required class (a classname to restrict which class types can be set with this key). This method is provided for wrappers. Use the constructor directly from C++ instead.

Definition at line 58 of file vtkInformationObjectBaseVectorKey.h.

void vtkInformationObjectBaseVectorKey::Clear ( vtkInformation * info )

Clear the vector.

void vtkInformationObjectBaseVectorKey::Resize	(	vtkInformation *	info,
		int	n
	)

Resize (extend) the vector to hold n objects. Any new elements created will be null initialized.

int vtkInformationObjectBaseVectorKey::Size ( vtkInformation * info )

Get the vector's length.

int vtkInformationObjectBaseVectorKey::Length ( vtkInformation * info ) [inline]

Get the vector's length.

Definition at line 73 of file vtkInformationObjectBaseVectorKey.h.

void vtkInformationObjectBaseVectorKey::Append	(	vtkInformation *	info,
		vtkObjectBase *	value
	)

Put the value on the back of the vector, with ref counting.

void vtkInformationObjectBaseVectorKey::Set	(	vtkInformation *	info,
		vtkObjectBase *	value,
		int	i
	)

Set element i of the vector to value. Resizes the vector if needed.

void vtkInformationObjectBaseVectorKey::SetRange	(	vtkInformation *	info,
		vtkObjectBase **	source,
		int	from,
		int	to,
		int	n
	)

Copy n values from the range in source defined by [from from+n-1] into the range in this vector defined by [to to+n-1]. Resizes the vector if needed.

void vtkInformationObjectBaseVectorKey::GetRange	(	vtkInformation *	info,
		vtkObjectBase **	dest,
		int	from,
		int	to,
		int	n
	)

Copy n values from the range in this vector defined by [from from+n-1] into the range in the destination vector defined by [to to+n-1]. Up to you to make sure the destination is big enough.

vtkObjectBase* vtkInformationObjectBaseVectorKey::Get	(	vtkInformation *	info,
		int	idx
	)

Get the vtkObjectBase at a specific location in the vector.

virtual void vtkInformationObjectBaseVectorKey::ShallowCopy	(	vtkInformation *	from,
		vtkInformation *	to
	)		`[virtual]`

Copy the entry associated with this key from one information object to another. If there is no entry in the first information object for this key, the value is removed from the second.

Implements vtkInformationKey.