BALL::InRingPredicate Class Reference

#include <BALL/KERNEL/standardPredicates.h>

Inheritance diagram for BALL::InRingPredicate:

Public Member Functions
	InRingPredicate ()
	Default constructor;.
	InRingPredicate (Size n)
	Detailed constructor;.
	~InRingPredicate ()
	Destructor;.
virtual bool	operator() (const Atom &atom) const
Public Member Functions inherited from BALL::ExpressionPredicate
	ExpressionPredicate ()
	ExpressionPredicate (const ExpressionPredicate &predicate)
	ExpressionPredicate (const String &argument)
virtual	~ExpressionPredicate ()
ExpressionPredicate &	operator= (const ExpressionPredicate &predicate)
virtual void	clear ()
bool	operator== (const ExpressionPredicate &predicate) const
virtual void	setArgument (const String &argument)
const String &	getArgument () const
Public Member Functions inherited from BALL::UnaryPredicate< Atom >
virtual	~UnaryPredicate ()
virtual bool	operator() (const Atom &) const

Additional Inherited Members
String	argument_

Detailed Description

Predicate for atoms being included in rings of a certain number.

Definition at line 322 of file standardPredicates.h.

Constructor & Destructor Documentation

InRingPredicate() [1/2]

BALL::InRingPredicate::InRingPredicate

(

)

Default constructor;.

InRingPredicate() [2/2]

BALL::InRingPredicate::InRingPredicate

(

Size

n

)

Detailed constructor;.

~InRingPredicate()

BALL::InRingPredicate::~InRingPredicate

(

)

Destructor;.

Member Function Documentation

operator()()

virtual bool BALL::InRingPredicate::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.