CDPL.Chem.TopologicalEntity3DAlignment Class Reference

Inheritance diagram for CDPL.Chem.TopologicalEntity3DAlignment:

Public Member Functions
None	__init__ ()
	Initializes the TopologicalEntity3DAlignment instance.
None	__init__ (TopologicalEntity3DAlignment alignment)
	Initializes a copy of the TopologicalEntity3DAlignment instance alignment. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
None	setEntityMatchFunction (BoolEntity3D2Functor func)
BoolEntity3D2Functor	getEntityMatchFunction ()
None	setEntityPairMatchFunction (BoolEntity3D4Functor func)
BoolEntity3D4Functor	getEntityPairMatchFunction ()
None	addEntity (Entity3D entity, bool first_set)
None	clearEntities (bool first_set)
int	getNumEntities (bool first_set)
object	getEntities (bool first_set)
Entity3D	getEntity (int idx, bool first_set)
None	reset ()
bool	nextAlignment (Util.STPairArray mapping)
TopologicalEntity3DAlignment	assign (TopologicalEntity3DAlignment alignment)
	Replaces the current state of self with a copy of the state of the TopologicalEntity3DAlignment instance alignment. More...

Properties
	objectID = property(getObjectID)
	entityMatchFunction = property(getEntityMatchFunction, setEntityMatchFunction)
	entityPairMatchFunction = property(getEntityPairMatchFunction, setEntityPairMatchFunction)

Constructor & Destructor Documentation

__init__()

None CDPL.Chem.TopologicalEntity3DAlignment.__init__

(

TopologicalEntity3DAlignment

alignment

)

Initializes a copy of the TopologicalEntity3DAlignment instance alignment.

Parameters

alignment

The TopologicalEntity3DAlignment instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Chem.TopologicalEntity3DAlignment.getObjectID

(

)

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

Different Python TopologicalEntity3DAlignment 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 TopologicalEntity3DAlignment 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.

setEntityMatchFunction()

None CDPL.Chem.TopologicalEntity3DAlignment.setEntityMatchFunction

(

BoolEntity3D2Functor

func

)

Parameters

func

getEntityMatchFunction()

BoolEntity3D2Functor CDPL.Chem.TopologicalEntity3DAlignment.getEntityMatchFunction

(

)

Returns

setEntityPairMatchFunction()

None CDPL.Chem.TopologicalEntity3DAlignment.setEntityPairMatchFunction

(

BoolEntity3D4Functor

func

)

Parameters

func

getEntityPairMatchFunction()

BoolEntity3D4Functor CDPL.Chem.TopologicalEntity3DAlignment.getEntityPairMatchFunction

(

)

Returns

addEntity()

None CDPL.Chem.TopologicalEntity3DAlignment.addEntity	(	Entity3D	entity,
		bool	first_set
	)

Parameters

entity
first_set

clearEntities()

None CDPL.Chem.TopologicalEntity3DAlignment.clearEntities

(

bool

first_set

)

Parameters

first_set

getNumEntities()

int CDPL.Chem.TopologicalEntity3DAlignment.getNumEntities

(

bool

first_set

)

Parameters

first_set

Returns

getEntities()

object CDPL.Chem.TopologicalEntity3DAlignment.getEntities

(

bool

first_set

)

Parameters

first_set

Returns

getEntity()

Entity3D CDPL.Chem.TopologicalEntity3DAlignment.getEntity	(	int	idx,
		bool	first_set
	)

Parameters

idx
first_set

Returns

nextAlignment()

bool CDPL.Chem.TopologicalEntity3DAlignment.nextAlignment

(

Util.STPairArray

mapping

)

Parameters

mapping

Returns

assign()

TopologicalEntity3DAlignment CDPL.Chem.TopologicalEntity3DAlignment.assign

(

TopologicalEntity3DAlignment

alignment

)

Replaces the current state of self with a copy of the state of the TopologicalEntity3DAlignment instance alignment.

Parameters

alignment

The TopologicalEntity3DAlignment instance to copy.

Returns

self