CDPL.Chem.SubstructureHistogramCalculator.Pattern Class Reference

Inheritance diagram for CDPL.Chem.SubstructureHistogramCalculator.Pattern:

Public Member Functions
None	__init__ (Pattern ptn)
	Initializes a copy of the Pattern instance ptn. More...
None	__init__ (MolecularGraph structure, int id, int priority=0, bool all_matches=True, bool unique_matches=True)
	Initializes the Pattern instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
Pattern	assign (Pattern ptn)
	Replaces the current state of self with a copy of the state of the Pattern instance ptn. More...
MolecularGraph	getStructure ()
int	getPriority ()
int	getID ()
bool	processAllMatches ()
bool	processUniqueMatchesOnly ()

Properties
	objectID = property(getObjectID)
	structure = property(getStructure)
	priority = property(getPriority)
	id = property(getID)
	allMatches = property(processAllMatches)
	uniqueMatches = property(processUniqueMatchesOnly)

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Chem.SubstructureHistogramCalculator.Pattern.__init__

(

Pattern

ptn

)

Initializes a copy of the Pattern instance ptn.

Parameters

ptn	The Pattern instance to copy.

__init__() [2/2]

None CDPL.Chem.SubstructureHistogramCalculator.Pattern.__init__	(	MolecularGraph	structure,
		int	id,
		int	priority = 0,
		bool	all_matches = True,
		bool	unique_matches = True
	)

Initializes the Pattern instance.

Parameters

structure
id
priority
all_matches
unique_matches

Member Function Documentation

getObjectID()

int CDPL.Chem.SubstructureHistogramCalculator.Pattern.getObjectID

(

)

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

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

Pattern CDPL.Chem.SubstructureHistogramCalculator.Pattern.assign

(

Pattern

ptn

)

Replaces the current state of self with a copy of the state of the Pattern instance ptn.

Parameters

ptn	The Pattern instance to copy.

Returns

self

getStructure()

MolecularGraph CDPL.Chem.SubstructureHistogramCalculator.Pattern.getStructure

(

)

Returns

getPriority()

int CDPL.Chem.SubstructureHistogramCalculator.Pattern.getPriority

(

)

Returns

getID()

int CDPL.Chem.SubstructureHistogramCalculator.Pattern.getID

(

)

Returns

processAllMatches()

bool CDPL.Chem.SubstructureHistogramCalculator.Pattern.processAllMatches

(

)

Returns

processUniqueMatchesOnly()

bool CDPL.Chem.SubstructureHistogramCalculator.Pattern.processUniqueMatchesOnly

(

)

Returns