utl::Predicate Class Reference

Logical predicate abstraction. More...

#include <Predicate.h>

Inheritance diagram for utl::Predicate:

Public Member Functions
bool	isOwner () const
	Get the ownership flag. More...
void	setOwner (bool owner)
	Set the ownership flag. More...
virtual int	compare (const Object &rhs) const
	Compare with an object by evaluating the predicate for the object. More...
virtual bool	eval (const Object *object) const =0
	Evaluate the predicate for the given object. More...
bool	operator() (const Object *object) const
	Another way of writing eval. More...
Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...
virtual void	copy (const Object &rhs)
	Copy another instance. More...
virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...
virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...
virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...
void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...
virtual const Object &	getKey () const
	Get the key for this object. More...
bool	hasKey () const
	Determine whether or not the object has a key. More...
virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...
virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...
virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...
bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...
virtual String	toString () const
	Return a string representation of self. More...
	operator String () const
	Conversion to String. More...
size_t	allocatedSize () const
	Get the total allocated size of this object. More...
virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...
virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...
virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...
bool	operator< (const Object &rhs) const
	Less-than operator. More...
bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...
bool	operator> (const Object &rhs) const
	Greater-than operator. More...
bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...
bool	operator== (const Object &rhs) const
	Equal-to operator. More...
bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...
void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...
void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...
virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...
void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...
static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...
static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...
static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...
static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...
Protected Member Functions inherited from utl::FlagsMI
	FlagsMI ()
	Constructor. More...
virtual	~FlagsMI ()
	Destructor. More...
void	copyFlags (const FlagsMI &rhs)
	Copy the given flags. More...
void	copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...
void	copyFlags (uint64_t flags, uint_t lsb, uint_t msb)
	Copy (some of) the given flags. More...
bool	getFlag (uint_t flagNum) const
	Get a user-defined flag. More...
void	setFlag (uint_t flagNum, bool val)
	Set a user-defined flag. More...
uint64_t	getFlagsNumber (uint64_t mask, uint64_t shift=0)
	Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More...
void	setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num)
	Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More...
uint64_t	getFlags () const
	Get the flags. More...
void	setFlags (uint64_t flags)
	Set the flags. More...

Detailed Description

Logical predicate abstraction.

A Predicate is a statement about an object that is either true or false.

Author

Adam McKee

Definition at line 26 of file Predicate.h.

Member Function Documentation

isOwner()

bool utl::Predicate::isOwner ( ) const

inline

Get the ownership flag.

Definition at line 34 of file Predicate.h.

setOwner()

void utl::Predicate::setOwner ( bool  owner )

inline

Set the ownership flag.

Definition at line 41 of file Predicate.h.

References utl::compare().

compare()

virtual int utl::Predicate::compare ( const Object &  rhs ) const

virtual

Compare with an object by evaluating the predicate for the object.

Returns

0 if predicate is true for rhs, 1 otherwise

Parameters

rhs	object to compare with

Reimplemented from utl::Object.

eval()

virtual bool utl::Predicate::eval ( const Object *  object ) const

pure virtual

Evaluate the predicate for the given object.

Returns

true if object satisfies predicate, false otherwise

Parameters

object

object to evaluate predicate for

Implemented in utl::GreaterThanOrEqualTo, utl::GreaterThan, utl::LessThanOrEqualTo, utl::LessThan, utl::EqualTo, utl::Or, utl::And, utl::Not, utl::IsA, and utl::FSobjectFilter.

operator()()

bool utl::Predicate::operator() ( const Object *  object ) const

inline

Another way of writing eval.

For example:

Object* object;
.
.
.
MyPredicate myPredicate;
bool predicateSatisfied = myPredicate(object);

Returns

true if object satisfies predicate, false otherwise

Parameters

object

object to evaluate predicate for.

Definition at line 75 of file Predicate.h.

---

The documentation for this class was generated from the following file:

• Predicate.h