CDPL.Grid.FRegularGridSet Class Reference

Convenience alias for the single-precision regular spatial grid sets. More...

Inheritance diagram for CDPL.Grid.FRegularGridSet:

Public Member Functions
None	__init__ ()
	Contructs the FRegularGridSet instance.
None	__init__ (FRegularGridSet set)
	Contructs a copy of the FRegularGridSet 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, FRegularGrid value)
None	reserve (int num_elem)
int	getCapacity ()
None	clear ()
FRegularGridSet	assign (FRegularGridSet set)
	Replaces the current state with a copy of the state of the FRegularGridSet instance set. More...
None	assign (int num_elem, FRegularGrid value)
	Replaces the current state with a copy of the state of the int instance num_elem. More...
None	addElement (FRegularGrid value)
None	addElements (FRegularGridSet values)
None	insertElement (int idx, FRegularGrid value)
None	insertElements (int idx, int num_elem, FRegularGrid value)
None	insertElements (int idx, FRegularGridSet 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...
FRegularGrid	getFirstElement ()
FRegularGrid	getLastElement ()
FRegularGrid	getElement (int idx)
None	setElement (int idx, FRegularGrid value)
None	__delitem__ (int idx)
FRegularGrid	__getitem__ (int idx)
int	__len__ ()
None	__setitem__ (int idx, FRegularGrid value)
bool	__eq__ (object set)
	Returns the result of the comparison operation self == set. More...
bool	__ne__ (object set)
	Returns the result of the comparison operation self != set. More...

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

Detailed Description

Convenience alias for the single-precision regular spatial grid sets.

Constructor & Destructor Documentation

__init__()

None CDPL.Grid.FRegularGridSet.__init__

(

FRegularGridSet

set

)

Contructs a copy of the FRegularGridSet instance set.

Parameters

set	The FRegularGridSet instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Grid.FRegularGridSet.getObjectID

(

)

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

Different Python FRegularGridSet 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 FRegularGridSet 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]

FRegularGridSet CDPL.Grid.FRegularGridSet.assign

(

FRegularGridSet

set

)

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

Parameters

set	The FRegularGridSet instance to copy.

Returns

self.

assign() [2/2]

None CDPL.Grid.FRegularGridSet.assign	(	int	num_elem,
		FRegularGrid	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.Grid.FRegularGridSet.insertElements	(	int	idx,
		FRegularGridSet	values
	)

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

Parameters

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

Exceptions

Base.IndexError

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

removeElements()

None CDPL.Grid.FRegularGridSet.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.Grid.FRegularGridSet.__eq__

(

object

set

)

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

Parameters

set	The object instance to be compared with.

Returns

The result of the comparison operation.

__ne__()

bool CDPL.Grid.FRegularGridSet.__ne__

(

object

set

)

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

Parameters

set	The object instance to be compared with.

Returns

The result of the comparison operation.