CDPL.Chem.FragmentGenerator.ExcludePattern Class Reference

Inheritance diagram for CDPL.Chem.FragmentGenerator.ExcludePattern:

Public Member Functions
None	__init__ (ExcludePattern excl_ptn)
	Initializes a copy of the ExcludePattern instance excl_ptn. More...
None	__init__ (MolecularGraph match_ptn, int rule_id)
	Initializes the ExcludePattern instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
ExcludePattern	assign (ExcludePattern excl_ptn)
	Replaces the current state of self with a copy of the state of the ExcludePattern instance excl_ptn. More...
MolecularGraph	getMatchPattern ()
None	setMatchPattern (MolecularGraph ptn)
int	getRuleID ()
None	setRuleID (int id)
bool	isGeneric ()
None	setGeneric (bool generic)

Properties
	objectID = property(getObjectID)
	matchPattern = property(getMatchPattern, setMatchPattern)
	ruleID = property(getRuleID, setRuleID)
	generic = property(isGeneric, setGeneric)

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Chem.FragmentGenerator.ExcludePattern.__init__

(

ExcludePattern

excl_ptn

)

Initializes a copy of the ExcludePattern instance excl_ptn.

Parameters

excl_ptn

The ExcludePattern instance to copy.

__init__() [2/2]

None CDPL.Chem.FragmentGenerator.ExcludePattern.__init__	(	MolecularGraph	match_ptn,
		int	rule_id
	)

Initializes the ExcludePattern instance.

Parameters

match_ptn
rule_id

Member Function Documentation

getObjectID()

int CDPL.Chem.FragmentGenerator.ExcludePattern.getObjectID

(

)

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

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

ExcludePattern CDPL.Chem.FragmentGenerator.ExcludePattern.assign

(

ExcludePattern

excl_ptn

)

Replaces the current state of self with a copy of the state of the ExcludePattern instance excl_ptn.

Parameters

excl_ptn

The ExcludePattern instance to copy.

Returns

self

getMatchPattern()

MolecularGraph CDPL.Chem.FragmentGenerator.ExcludePattern.getMatchPattern

(

)

Returns

setMatchPattern()

None CDPL.Chem.FragmentGenerator.ExcludePattern.setMatchPattern

(

MolecularGraph

ptn

)

Parameters

ptn

getRuleID()

int CDPL.Chem.FragmentGenerator.ExcludePattern.getRuleID

(

)

Returns

setRuleID()

None CDPL.Chem.FragmentGenerator.ExcludePattern.setRuleID

(

int

id

)

Parameters

id

isGeneric()

bool CDPL.Chem.FragmentGenerator.ExcludePattern.isGeneric

(

)

Returns

setGeneric()

None CDPL.Chem.FragmentGenerator.ExcludePattern.setGeneric

(

bool

generic

)

Parameters

generic