Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

ExpressionPredicate Class Reference
[Kernel Predicates]

ExpressionPredicate. More...

#include <expressionPredicate.h>

Inheritance diagram for ExpressionPredicate:

UnaryPredicate< Atom > AtomNamePredicate AtomTypePredicate AxialPredicate BackBonePredicate ChainPredicate ChargePredicate Conformation4C1Predicate ConnectedToPredicate ElementPredicate FalsePredicate InRingPredicate MoleculePredicate NucleotidePredicate NumberOfBondsPredicate ProteinPredicate ResidueIDPredicate ResiduePredicate SecondaryStructurePredicate SelectedPredicate SMARTSPredicate SolventPredicate Sp2HybridizedPredicate Sp3HybridizedPredicate SpHybridizedPredicate TruePredicate List of all members.

Public Member Functions

Constructors and Destructor.
 ExpressionPredicate () throw ()
 Default Constructor.
 ExpressionPredicate (const ExpressionPredicate &predicate) throw ()
 Copy constructor.
 ExpressionPredicate (const String &argument) throw ()
 Detailed Constructor.
virtual ~ExpressionPredicate () throw ()
 Destructor.
Assignment
ExpressionPredicateoperator= (const ExpressionPredicate &predicate) throw ()
 Assignment operator.
virtual void clear () throw ()
 Clear method.
Predicates
bool operator== (const ExpressionPredicate &predicate) const throw ()
 Equality operator.
Accessors.
virtual bool operator() (const Atom &atom) const throw ()
 evaluate this ExpressionPredicate by comparing its argument with the selected predicate of atom.
virtual void setArgument (const String &argument) throw ()
 set the Argument of this ExpressionPredicate
const StringgetArgument () const throw ()
 Get the argument of an ExpressionPredicate.

Protected Attributes

String argument_

Detailed Description

ExpressionPredicate.

The base class for all kernel predicates (defined in BALL/KERNEL/standardPredicates.h and used by Expression . You have to derive your own predicate classes from this class if you want to use (and register) them with Expression .

See also:
Expression


Constructor & Destructor Documentation

ExpressionPredicate::ExpressionPredicate const String argument  )  throw ()
 

Detailed Constructor.

Construct an ExpressionPredicate with a string.

Parameters:
argument the argument to use for this predicate


Member Function Documentation

const String& ExpressionPredicate::getArgument  )  const throw ()
 

Get the argument of an ExpressionPredicate.

Returns:
the argument of the expression

virtual bool ExpressionPredicate::operator() const Atom atom  )  const throw () [virtual]
 

evaluate this ExpressionPredicate by comparing its argument with the selected predicate of atom.

Parameters:
atom the atom to compare with

Reimplemented from UnaryPredicate< Atom >.

Reimplemented in TruePredicate, FalsePredicate, SelectedPredicate, AtomNamePredicate, AtomTypePredicate, ElementPredicate, ResiduePredicate, ResidueIDPredicate, ProteinPredicate, ChainPredicate, SecondaryStructurePredicate, SolventPredicate, MoleculePredicate, BackBonePredicate, NucleotidePredicate, InRingPredicate, NumberOfBondsPredicate, SingleBondsPredicate, DoubleBondsPredicate, TripleBondsPredicate, AromaticBondsPredicate, ConnectedToPredicate, SpHybridizedPredicate, Sp2HybridizedPredicate, Sp3HybridizedPredicate, ChargePredicate, AxialPredicate, Conformation4C1Predicate, and SMARTSPredicate.

virtual void ExpressionPredicate::setArgument const String argument  )  throw () [virtual]
 

set the Argument of this ExpressionPredicate

Parameters:
argument the string to use for this predicate

Reimplemented in ConnectedToPredicate.