CDPL.Shape.GaussianShapeSet Class Reference

Data structure storing a set of (shared) Gaussian shapes. More...

Inheritance diagram for CDPL.Shape.GaussianShapeSet:

Public Member Functions
None	__init__ ()
	Contructs the GaussianShapeSet instance.
None	__init__ (GaussianShapeSet set)
	Contructs a copy of the GaussianShapeSet instance set. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
int	getSize ()
bool	isEmpty ()
None	resize (int num_elem, GaussianShape value)
None	reserve (int num_elem)
int	getCapacity ()
None	clear ()
GaussianShapeSet	assign (GaussianShapeSet set)
	Replaces the current state with a copy of the state of the GaussianShapeSet instance set. More...
None	assign (int num_elem, GaussianShape value)
	Replaces the current state with a copy of the state of the int instance num_elem. More...
None	addElement (GaussianShape value)
None	addElements (GaussianShapeSet values)
None	insertElement (int idx, GaussianShape value)
None	insertElements (int idx, int num_elem, GaussianShape value)
None	insertElements (int idx, GaussianShapeSet values)
	Insert the elements of values before the location specified by the index idx. More...
None	popLastElement ()
None	removeElement (int idx)
None	removeElements (int begin_idx, int end_idx)
	Removes the elements at indices in the range [begin_idx, end_idx). More...
GaussianShape	getFirstElement ()
GaussianShape	getLastElement ()
GaussianShape	getElement (int idx)
None	setElement (int idx, GaussianShape value)
None	__delitem__ (int idx)
GaussianShape	__getitem__ (int idx)
int	__len__ ()
None	__setitem__ (int idx, GaussianShape value)
bool	__eq__ (object list)
	Returns the result of the comparison operation self == list. More...
bool	__ne__ (object list)
	Returns the result of the comparison operation self != list. More...

Properties
	objectID = property(getObjectID)
	size = property(getSize)

Detailed Description

Data structure storing a set of (shared) Gaussian shapes.

GaussianShapeSet is an indirect array of Shape.GaussianShape smart references, typically used as input to alignment / overlap routines that operate on multiple shapes at once.

Constructor & Destructor Documentation

__init__()

None CDPL.Shape.GaussianShapeSet.__init__

(

GaussianShapeSet

set

)

Contructs a copy of the GaussianShapeSet instance set.

Parameters

set	The GaussianShapeSet instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Shape.GaussianShapeSet.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python GaussianShapeSet instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two GaussianShapeSet instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

assign() [1/2]

GaussianShapeSet CDPL.Shape.GaussianShapeSet.assign

(

GaussianShapeSet

set

)

Replaces the current state with a copy of the state of the GaussianShapeSet instance set.

Parameters

set	The GaussianShapeSet instance to copy.

Returns

self.

assign() [2/2]

None CDPL.Shape.GaussianShapeSet.assign	(	int	num_elem,
		GaussianShape	value
	)

Replaces the current state with a copy of the state of the int instance num_elem.

Parameters

num_elem

The int instance to copy.

Returns

self.

insertElements()

None CDPL.Shape.GaussianShapeSet.insertElements	(	int	idx,
		GaussianShapeSet	values
	)

Insert the elements of values before the location specified by the index idx.

Parameters

idx	The zero-based insertion index.
values	The GaussianShapeSet instance providing the elements to insert.

Exceptions

Base.IndexError

if idx is not in the range [0, getSize()].

removeElements()

None CDPL.Shape.GaussianShapeSet.removeElements	(	int	begin_idx,
		int	end_idx
	)

Removes the elements at indices in the range [begin_idx, end_idx).

Parameters

begin_idx	The zero-based index range start.
end_idx	The zero-based index range end.

Exceptions

Base.IndexError

if begin_idx or end_idx is not in the range [0, getSize()] or end_idx < begin_idx.

__eq__()

bool CDPL.Shape.GaussianShapeSet.__eq__

(

object

list

)

Returns the result of the comparison operation self == list.

Parameters

list	The object instance to be compared with.

Returns

The result of the comparison operation.

__ne__()

bool CDPL.Shape.GaussianShapeSet.__ne__

(

object

list

)

Returns the result of the comparison operation self != list.

Parameters

list	The object instance to be compared with.

Returns

The result of the comparison operation.