CDPL.Chem.ElectronSystemList Class Reference

A data type for the storage of Chem.ElectronSystem objects. More...

Inheritance diagram for CDPL.Chem.ElectronSystemList:

Public Member Functions
None	__init__ ()
	Initializes the ElectronSystemList instance.
None	__init__ (ElectronSystemList list)
	Initializes a copy of the ElectronSystemList instance list. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
int	getSize ()
bool	isEmpty ()
None	resize (int num_elem, ElectronSystem value)
None	reserve (int num_elem)
int	getCapacity ()
None	clear ()
ElectronSystemList	assign (ElectronSystemList array)
	Replaces the current state of self with a copy of the state of the ElectronSystemList instance array. More...
None	assign (int num_elem, ElectronSystem value)
None	addElement (ElectronSystem value)
None	addElements (ElectronSystemList values)
None	insertElement (int idx, ElectronSystem value)
None	insertElements (int idx, int num_elem, ElectronSystem value)
None	insertElements (int index, ElectronSystemList values)
None	popLastElement ()
None	removeElement (int idx)
None	removeElements (int begin_idx, int end_idx)
ElectronSystem	getFirstElement ()
ElectronSystem	getLastElement ()
ElectronSystem	getElement (int idx)
None	setElement (int idx, ElectronSystem value)
None	__delitem__ (int idx)
ElectronSystem	__getitem__ (int idx)
int	__len__ ()
None	__setitem__ (int index, ElectronSystem 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

A data type for the storage of Chem.ElectronSystem objects.

Constructor & Destructor Documentation

__init__()

None CDPL.Chem.ElectronSystemList.__init__

(

ElectronSystemList

list

)

Initializes a copy of the ElectronSystemList instance list.

Parameters

list	The ElectronSystemList instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Chem.ElectronSystemList.getObjectID

(

)

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

Different Python ElectronSystemList 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 ElectronSystemList 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.Chem.ElectronSystemList.getSize

(

)

Returns

isEmpty()

bool CDPL.Chem.ElectronSystemList.isEmpty

(

)

Returns

resize()

None CDPL.Chem.ElectronSystemList.resize	(	int	num_elem,
		ElectronSystem	value
	)

Parameters

num_elem
value

reserve()

None CDPL.Chem.ElectronSystemList.reserve

(

int

num_elem

)

Parameters

num_elem

getCapacity()

int CDPL.Chem.ElectronSystemList.getCapacity

(

)

Returns

assign() [1/2]

ElectronSystemList CDPL.Chem.ElectronSystemList.assign

(

ElectronSystemList

array

)

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

Parameters

array

The ElectronSystemList instance to copy.

Returns

self

assign() [2/2]

None CDPL.Chem.ElectronSystemList.assign	(	int	num_elem,
		ElectronSystem	value
	)

Parameters

num_elem
value

addElement()

None CDPL.Chem.ElectronSystemList.addElement

(

ElectronSystem

value

)

Parameters

value

addElements()

None CDPL.Chem.ElectronSystemList.addElements

(

ElectronSystemList

values

)

Parameters

values

insertElement()

None CDPL.Chem.ElectronSystemList.insertElement	(	int	idx,
		ElectronSystem	value
	)

Parameters

idx
value

insertElements() [1/2]

None CDPL.Chem.ElectronSystemList.insertElements	(	int	idx,
		int	num_elem,
		ElectronSystem	value
	)

Parameters

idx
num_elem
value

insertElements() [2/2]

None CDPL.Chem.ElectronSystemList.insertElements	(	int	index,
		ElectronSystemList	values
	)

Parameters

index
values

removeElement()

None CDPL.Chem.ElectronSystemList.removeElement

(

int

idx

)

Parameters

idx

removeElements()

None CDPL.Chem.ElectronSystemList.removeElements	(	int	begin_idx,
		int	end_idx
	)

Parameters

begin_idx
end_idx

getFirstElement()

ElectronSystem CDPL.Chem.ElectronSystemList.getFirstElement

(

)

Returns

getLastElement()

ElectronSystem CDPL.Chem.ElectronSystemList.getLastElement

(

)

Returns

getElement()

ElectronSystem CDPL.Chem.ElectronSystemList.getElement

(

int

idx

)

Parameters

idx

Returns

setElement()

None CDPL.Chem.ElectronSystemList.setElement	(	int	idx,
		ElectronSystem	value
	)

Parameters

idx
value

__delitem__()

None CDPL.Chem.ElectronSystemList.__delitem__

(

int

idx

)

Parameters

idx

__getitem__()

ElectronSystem CDPL.Chem.ElectronSystemList.__getitem__

(

int

idx

)

Parameters

idx

Returns

__len__()

int CDPL.Chem.ElectronSystemList.__len__

(

)

Returns

__setitem__()

None CDPL.Chem.ElectronSystemList.__setitem__	(	int	index,
		ElectronSystem	value
	)

Parameters

index
value

__eq__()

bool CDPL.Chem.ElectronSystemList.__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.Chem.ElectronSystemList.__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.