CDPL.Grid.FRegularGridSet Class Reference

RegularGridSet. More...

Inheritance diagram for CDPL.Grid.FRegularGridSet:

Public Member Functions
None	__init__ ()
	Initializes the FRegularGridSet instance.
None	__init__ (FRegularGridSet set)
	Initializes 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 array)
	Replaces the current state of self with a copy of the state of the FRegularGridSet instance array. More...
None	assign (int num_elem, FRegularGrid value)
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 index, FRegularGridSet values)
None	popLastElement ()
None	removeElement (int idx)
None	removeElements (int begin_idx, int end_idx)
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 index, 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

RegularGridSet.

Constructor & Destructor Documentation

__init__()

None CDPL.Grid.FRegularGridSet.__init__

(

FRegularGridSet

set

)

Initializes 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.

getSize()

int CDPL.Grid.FRegularGridSet.getSize

(

)

Returns

isEmpty()

bool CDPL.Grid.FRegularGridSet.isEmpty

(

)

Returns

resize()

None CDPL.Grid.FRegularGridSet.resize	(	int	num_elem,
		FRegularGrid	value
	)

Parameters

num_elem
value

reserve()

None CDPL.Grid.FRegularGridSet.reserve

(

int

num_elem

)

Parameters

num_elem

getCapacity()

int CDPL.Grid.FRegularGridSet.getCapacity

(

)

Returns

assign() [1/2]

FRegularGridSet CDPL.Grid.FRegularGridSet.assign

(

FRegularGridSet

array

)

Replaces the current state of self with a copy of the state of the FRegularGridSet instance array.

Parameters

array

The FRegularGridSet instance to copy.

Returns

self

assign() [2/2]

None CDPL.Grid.FRegularGridSet.assign	(	int	num_elem,
		FRegularGrid	value
	)

Parameters

num_elem
value

addElement()

None CDPL.Grid.FRegularGridSet.addElement

(

FRegularGrid

value

)

Parameters

value

addElements()

None CDPL.Grid.FRegularGridSet.addElements

(

FRegularGridSet

values

)

Parameters

values

insertElement()

None CDPL.Grid.FRegularGridSet.insertElement	(	int	idx,
		FRegularGrid	value
	)

Parameters

idx
value

insertElements() [1/2]

None CDPL.Grid.FRegularGridSet.insertElements	(	int	idx,
		int	num_elem,
		FRegularGrid	value
	)

Parameters

idx
num_elem
value

insertElements() [2/2]

None CDPL.Grid.FRegularGridSet.insertElements	(	int	index,
		FRegularGridSet	values
	)

Parameters

index
values

removeElement()

None CDPL.Grid.FRegularGridSet.removeElement

(

int

idx

)

Parameters

idx

removeElements()

None CDPL.Grid.FRegularGridSet.removeElements	(	int	begin_idx,
		int	end_idx
	)

Parameters

begin_idx
end_idx

getFirstElement()

FRegularGrid CDPL.Grid.FRegularGridSet.getFirstElement

(

)

Returns

getLastElement()

FRegularGrid CDPL.Grid.FRegularGridSet.getLastElement

(

)

Returns

getElement()

FRegularGrid CDPL.Grid.FRegularGridSet.getElement

(

int

idx

)

Parameters

idx

Returns

setElement()

None CDPL.Grid.FRegularGridSet.setElement	(	int	idx,
		FRegularGrid	value
	)

Parameters

idx
value

__delitem__()

None CDPL.Grid.FRegularGridSet.__delitem__

(

int

idx

)

Parameters

idx

__getitem__()

FRegularGrid CDPL.Grid.FRegularGridSet.__getitem__

(

int

idx

)

Parameters

idx

Returns

__len__()

int CDPL.Grid.FRegularGridSet.__len__

(

)

Returns

__setitem__()

None CDPL.Grid.FRegularGridSet.__setitem__	(	int	index,
		FRegularGrid	value
	)

Parameters

index
value

__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.