CDPL.Chem.FragmentGenerator.FragmentLink Class Reference

Inheritance diagram for CDPL.Chem.FragmentGenerator.FragmentLink:

Public Member Functions
None	__init__ (FragmentLink link)
	Initializes a copy of the FragmentLink instance link. More...
None	__init__ (int frag1_idx, int frag2_idx, Bond bond, int rule_id, int atom1_label, int atom2_label)
	Initializes the FragmentLink instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
FragmentLink	assign (FragmentLink link)
	Replaces the current state of self with a copy of the state of the FragmentLink instance link. More...
int	getFragment1Index ()
int	getFragment2Index ()
Bond	getBond ()
int	getRuleID ()
int	getAtom1Label ()
int	getAtom2Label ()

Properties
	objectID = property(getObjectID)
	fragment1Index = property(getFragment1Index)
	fragment2Index = property(getFragment2Index)
	bond = property(getBond)
	ruleID = property(getRuleID)
	atom1Label = property(getAtom1Label)
	atom2Label = property(getAtom2Label)

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Chem.FragmentGenerator.FragmentLink.__init__

(

FragmentLink

link

)

Initializes a copy of the FragmentLink instance link.

Parameters

link	The FragmentLink instance to copy.

__init__() [2/2]

None CDPL.Chem.FragmentGenerator.FragmentLink.__init__	(	int	frag1_idx,
		int	frag2_idx,
		Bond	bond,
		int	rule_id,
		int	atom1_label,
		int	atom2_label
	)

Initializes the FragmentLink instance.

Parameters

frag1_idx
frag2_idx
bond
rule_id
atom1_label
atom2_label

Member Function Documentation

getObjectID()

int CDPL.Chem.FragmentGenerator.FragmentLink.getObjectID

(

)

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

Different Python FragmentLink 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 FragmentLink 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()

FragmentLink CDPL.Chem.FragmentGenerator.FragmentLink.assign

(

FragmentLink

link

)

Replaces the current state of self with a copy of the state of the FragmentLink instance link.

Parameters

link	The FragmentLink instance to copy.

Returns

self

getFragment1Index()

int CDPL.Chem.FragmentGenerator.FragmentLink.getFragment1Index

(

)

Returns

getFragment2Index()

int CDPL.Chem.FragmentGenerator.FragmentLink.getFragment2Index

(

)

Returns

getBond()

Bond CDPL.Chem.FragmentGenerator.FragmentLink.getBond

(

)

Returns

getRuleID()

int CDPL.Chem.FragmentGenerator.FragmentLink.getRuleID

(

)

Returns

getAtom1Label()

int CDPL.Chem.FragmentGenerator.FragmentLink.getAtom1Label

(

)

Returns

getAtom2Label()

int CDPL.Chem.FragmentGenerator.FragmentLink.getAtom2Label

(

)

Returns