CDPL.ForceField.ElasticPotentialList Class Reference

Inheritance diagram for CDPL.ForceField.ElasticPotentialList:

Public Member Functions
None	__init__ ()
	Initializes the ElasticPotentialList instance.
None	__init__ (ElasticPotentialList list)
	Initializes a copy of the ElasticPotentialList 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, ElasticPotential value)
None	reserve (int num_elem)
int	getCapacity ()
None	clear ()
ElasticPotentialList	assign (ElasticPotentialList array)
	Replaces the current state of self with a copy of the state of the ElasticPotentialList instance array. More...
None	assign (int num_elem, ElasticPotential value)
None	addElement (ElasticPotential value)
None	addElements (ElasticPotentialList values)
None	insertElement (int idx, ElasticPotential value)
None	insertElements (int idx, int num_elem, ElasticPotential value)
None	insertElements (int index, ElasticPotentialList values)
None	popLastElement ()
None	removeElement (int idx)
None	removeElements (int begin_idx, int end_idx)
ElasticPotential	getFirstElement ()
ElasticPotential	getLastElement ()
ElasticPotential	getElement (int idx)
None	setElement (int idx, ElasticPotential value)
None	__delitem__ (int idx)
ElasticPotential	__getitem__ (int idx)
int	__len__ ()
None	__setitem__ (int index, ElasticPotential value)

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

Constructor & Destructor Documentation

__init__()

None CDPL.ForceField.ElasticPotentialList.__init__

(

ElasticPotentialList

list

)

Initializes a copy of the ElasticPotentialList instance list.

Parameters

list	The ElasticPotentialList instance to copy.

Member Function Documentation

getObjectID()

int CDPL.ForceField.ElasticPotentialList.getObjectID

(

)

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

Different Python ElasticPotentialList 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 ElasticPotentialList 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.ForceField.ElasticPotentialList.getSize

(

)

Returns

isEmpty()

bool CDPL.ForceField.ElasticPotentialList.isEmpty

(

)

Returns

resize()

None CDPL.ForceField.ElasticPotentialList.resize	(	int	num_elem,
		ElasticPotential	value
	)

Parameters

num_elem
value

reserve()

None CDPL.ForceField.ElasticPotentialList.reserve

(

int

num_elem

)

Parameters

num_elem

getCapacity()

int CDPL.ForceField.ElasticPotentialList.getCapacity

(

)

Returns

assign() [1/2]

ElasticPotentialList CDPL.ForceField.ElasticPotentialList.assign

(

ElasticPotentialList

array

)

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

Parameters

array

The ElasticPotentialList instance to copy.

Returns

self

assign() [2/2]

None CDPL.ForceField.ElasticPotentialList.assign	(	int	num_elem,
		ElasticPotential	value
	)

Parameters

num_elem
value

addElement()

None CDPL.ForceField.ElasticPotentialList.addElement

(

ElasticPotential

value

)

Parameters

value

addElements()

None CDPL.ForceField.ElasticPotentialList.addElements

(

ElasticPotentialList

values

)

Parameters

values

insertElement()

None CDPL.ForceField.ElasticPotentialList.insertElement	(	int	idx,
		ElasticPotential	value
	)

Parameters

idx
value

insertElements() [1/2]

None CDPL.ForceField.ElasticPotentialList.insertElements	(	int	idx,
		int	num_elem,
		ElasticPotential	value
	)

Parameters

idx
num_elem
value

insertElements() [2/2]

None CDPL.ForceField.ElasticPotentialList.insertElements	(	int	index,
		ElasticPotentialList	values
	)

Parameters

index
values

removeElement()

None CDPL.ForceField.ElasticPotentialList.removeElement

(

int

idx

)

Parameters

idx

removeElements()

None CDPL.ForceField.ElasticPotentialList.removeElements	(	int	begin_idx,
		int	end_idx
	)

Parameters

begin_idx
end_idx

getFirstElement()

ElasticPotential CDPL.ForceField.ElasticPotentialList.getFirstElement

(

)

Returns

getLastElement()

ElasticPotential CDPL.ForceField.ElasticPotentialList.getLastElement

(

)

Returns

getElement()

ElasticPotential CDPL.ForceField.ElasticPotentialList.getElement

(

int

idx

)

Parameters

idx

Returns

setElement()

None CDPL.ForceField.ElasticPotentialList.setElement	(	int	idx,
		ElasticPotential	value
	)

Parameters

idx
value

__delitem__()

None CDPL.ForceField.ElasticPotentialList.__delitem__

(

int

idx

)

Parameters

idx

__getitem__()

ElasticPotential CDPL.ForceField.ElasticPotentialList.__getitem__

(

int

idx

)

Parameters

idx

Returns

__len__()

int CDPL.ForceField.ElasticPotentialList.__len__

(

)

Returns

__setitem__()

None CDPL.ForceField.ElasticPotentialList.__setitem__	(	int	index,
		ElasticPotential	value
	)

Parameters

index
value