libUTL++
utl::BinaryPredicate Class Reference

Abstraction for two-parameter predicates. More...

#include <Predicate.h>

Inheritance diagram for utl::BinaryPredicate:

Public Member Functions

 BinaryPredicate (const Object &lhs, const Object &rhs, bool owner=true)
 Constructor. More...
 
 BinaryPredicate (const Object *lhs, const Object *rhs, bool owner=true)
 Constructor. More...
 
void clear ()
 See Object::clear. More...
 
virtual void copy (const Object &rhs)
 Copy another instance. More...
 
virtual void serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
 Serialize to or from a stream. More...
 
const ObjectgetLHS () const
 Get the left-hand-side parameter. More...
 
const ObjectgetRHS () const
 Get the right-hand-side parameter. More...
 
void setLHS (const Object &lhs)
 Set the left-hand-side parameter (make a copy if isOwner() = true). More...
 
void setLHS (const Object *lhs)
 Set the left-hand-side parameter. More...
 
void setRHS (const Object &lhs)
 Set the right-hand-side parameter (make a copy if isOwner() = true). More...
 
void setRHS (const Object *rhs)
 Set the right-hand-side parameter. More...
 
- Public Member Functions inherited from utl::Predicate
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 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 ObjectgetKey () const
 Get the key for this object. More...
 
bool hasKey () const
 Determine whether or not the object has a key. More...
 
virtual const ObjectgetProxiedObject () const
 Get the proxied object (= self if none). More...
 
virtual ObjectgetProxiedObject ()
 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...
 
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 ObjectserializeInNullable (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 ObjectserializeInBoxed (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

Abstraction for two-parameter predicates.

Author
Adam McKee

Definition at line 241 of file Predicate.h.

Constructor & Destructor Documentation

◆ BinaryPredicate() [1/2]

utl::BinaryPredicate::BinaryPredicate ( const Object lhs,
const Object rhs,
bool  owner = true 
)

Constructor.

Parameters
lhsleft-hand-side parameter (make a copy if owner = true)
rhsright-hand-side parameter (make a copy if owner = true)
ownerowner flag

◆ BinaryPredicate() [2/2]

utl::BinaryPredicate::BinaryPredicate ( const Object lhs,
const Object rhs,
bool  owner = true 
)

Constructor.

Parameters
lhsleft-hand-side parameter
rhsright-hand-side parameter
ownerowner flag

Member Function Documentation

◆ clear()

void utl::BinaryPredicate::clear ( )
inline

See Object::clear.

Definition at line 264 of file Predicate.h.

References utl::copy(), utl::ser_default, and utl::serialize().

◆ copy()

virtual void utl::BinaryPredicate::copy ( const Object rhs)
virtual

Copy another instance.

When you override copy(), you should usually call the superclass's copy().

Parameters
rhsobject to copy

Reimplemented from utl::Object.

◆ serialize()

virtual void utl::BinaryPredicate::serialize ( Stream stream,
uint_t  io,
uint_t  mode = ser_default 
)
virtual

Serialize to or from a stream.

This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.

Parameters
streamstream to serialize from/to
iosee utl::io_t
modesee utl::serialize_t

Reimplemented from utl::Object.

◆ getLHS()

const Object* utl::BinaryPredicate::getLHS ( ) const
inline

Get the left-hand-side parameter.

Definition at line 276 of file Predicate.h.

◆ getRHS()

const Object* utl::BinaryPredicate::getRHS ( ) const
inline

Get the right-hand-side parameter.

Definition at line 283 of file Predicate.h.

◆ setLHS() [1/2]

void utl::BinaryPredicate::setLHS ( const Object lhs)
inline

Set the left-hand-side parameter (make a copy if isOwner() = true).

Definition at line 290 of file Predicate.h.

◆ setLHS() [2/2]

void utl::BinaryPredicate::setLHS ( const Object lhs)
inline

Set the left-hand-side parameter.

Definition at line 300 of file Predicate.h.

◆ setRHS() [1/2]

void utl::BinaryPredicate::setRHS ( const Object lhs)
inline

Set the right-hand-side parameter (make a copy if isOwner() = true).

Definition at line 308 of file Predicate.h.

◆ setRHS() [2/2]

void utl::BinaryPredicate::setRHS ( const Object rhs)
inline

Set the right-hand-side parameter.

Definition at line 318 of file Predicate.h.

References utl::deInit(), and utl::init().


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