BALL::AromaticBondsPredicate

BALL::AromaticBondsPredicate Class Reference

#include <BALL/KERNEL/standardPredicates.h>

Inheritance diagram for BALL::AromaticBondsPredicate:
BALL::ExpressionPredicate BALL::UnaryPredicate< Atom >

List of all members.


Public Member Functions

virtual bool operator() (const Atom &atom) const

Protected Member Functions

bool testPredicate_ (const Atom &atom) const

Detailed Description

Predicate class for atoms bearing a certain number of aromatic bonds. Arguments of this class are required to consist of an relational operator and a number between 1 and 8. The default is ">0" which means that the atom under siege has to bear at least one aromatic bond to make this predicate's operator () () return true.

A bond is defined as aromatic if it has the property Bond::IS_AROMATIC set, or if its bond order equals Bond::ORDER__AROMATIC.

Member Function Documentation

virtual bool BALL::AromaticBondsPredicate::operator() ( const Atom &  atom  )  const [virtual]

Evaluate the predicate for the atom atom.

Parameters:
atom the atom to test
Returns:
true, if the predicate is true, false otherwise

Reimplemented from BALL::ExpressionPredicate.

bool BALL::AromaticBondsPredicate::testPredicate_ ( const Atom &  atom  )  const [protected]