libUTL++
utl::BitArrayElem Class Reference

Reference to a value stored in a BitArray. More...

#include <BitArrayElem.h>

Inheritance diagram for utl::BitArrayElem:

Public Member Functions

 BitArrayElem (BitArray *bitArray, uint64_t idx)
 Constructor. More...
 
virtual void copy (const Object &rhs)
 Copy another instance. More...
 
virtual String toString () const
 Return a string representation of self. More...
 
Accessors
BitArrayElem & operator= (uint_t val)
 Assignment from uint_t. More...
 
BitArrayElem & operator= (uint64_t val)
 Assignment from uint64_t. More...
 
BitArrayElem & operator= (bool val)
 Assignment from bool. More...
 
BitArrayElem & operator= (BitArrayElem &ref)
 Assignment from non-const BitArrayElem. More...
 
uint64_t get () const
 Get value. More...
 
 operator uint_t () const
 Conversion to uint_t. More...
 
 operator uint64_t () const
 Conversion to uint64_t. More...
 
 operator bool () const
 Conversion to bool. More...
 
Comparison Operators
bool operator== (bool rhs) const
 Equal-to operator. More...
 
bool operator!= (bool rhs) const
 Unequal-to operator. More...
 
bool operator< (uint64_t rhs) const
 Less-than operator. More...
 
bool operator<= (uint64_t rhs) const
 Less-than-or-equal-to operator. More...
 
bool operator> (uint64_t rhs) const
 Greater-than operator. More...
 
bool operator>= (uint64_t rhs) const
 Greater-than-or-equal-to operator. More...
 
bool operator== (uint64_t rhs) const
 Equal-to operator. More...
 
bool operator!= (uint64_t rhs) const
 Unequal-to operator. More...
 
bool operator< (int64_t rhs) const
 Less-than operator. More...
 
bool operator<= (int64_t rhs) const
 Less-than-or-equal-to operator. More...
 
bool operator> (int64_t rhs) const
 Greater-than operator. More...
 
bool operator>= (int64_t rhs) const
 Greater-than-or-equal-to operator. More...
 
bool operator== (int64_t rhs) const
 Equal-to operator. More...
 
bool operator!= (int64_t rhs) const
 Unequal-to operator. More...
 
bool operator< (const BitArrayElem &rhs) const
 Less-than operator. More...
 
bool operator<= (const BitArrayElem &rhs) const
 Less-than-or-equal-to operator. More...
 
bool operator> (const BitArrayElem &rhs) const
 Greater-than operator. More...
 
bool operator>= (const BitArrayElem &rhs) const
 Greater-than-or-equal-to operator. More...
 
bool operator== (const BitArrayElem &rhs) const
 Equal-to operator. More...
 
bool operator!= (const BitArrayElem &rhs) const
 Unequal-to operator. More...
 
- Public Member Functions inherited from utl::Object
void clear ()
 Revert to initial state. More...
 
virtual int compare (const Object &rhs) const
 Compare with another object. 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...
 
 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...
 

Detailed Description

Reference to a value stored in a BitArray.

You should not need to use BitArrayElem directly. You will use it indirectly when you invoke operator[] on a non-const BitArray.

Author
Adam McKee

Definition at line 27 of file BitArrayElem.h.

Constructor & Destructor Documentation

◆ BitArrayElem()

utl::BitArrayElem::BitArrayElem ( BitArray *  bitArray,
uint64_t  idx 
)
inline

Constructor.

Parameters
bitArrayassociated BitArray
idxvalue index

Definition at line 40 of file BitArrayElem.h.

References ASSERTD, utl::copy(), and utl::toString().

Member Function Documentation

◆ copy()

virtual void utl::BitArrayElem::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.

◆ toString()

virtual String utl::BitArrayElem::toString ( ) const
virtual

Return a string representation of self.

Reimplemented from utl::Object.

◆ operator=() [1/4]

BitArrayElem& utl::BitArrayElem::operator= ( uint_t  val)
inline

Assignment from uint_t.

Definition at line 54 of file BitArrayElem.h.

◆ operator=() [2/4]

BitArrayElem& utl::BitArrayElem::operator= ( uint64_t  val)
inline

Assignment from uint64_t.

Definition at line 61 of file BitArrayElem.h.

◆ operator=() [3/4]

BitArrayElem& utl::BitArrayElem::operator= ( bool  val)
inline

Assignment from bool.

Definition at line 68 of file BitArrayElem.h.

◆ operator=() [4/4]

BitArrayElem& utl::BitArrayElem::operator= ( BitArrayElem &  ref)
inline

Assignment from non-const BitArrayElem.

Definition at line 75 of file BitArrayElem.h.

References get().

◆ get()

uint64_t utl::BitArrayElem::get ( ) const
inline

Get value.

Definition at line 83 of file BitArrayElem.h.

References get().

Referenced by get(), operator!=(), operator<(), operator<=(), operator=(), operator==(), operator>(), and operator>=().

◆ operator uint_t()

utl::BitArrayElem::operator uint_t ( ) const
inline

Conversion to uint_t.

Definition at line 89 of file BitArrayElem.h.

◆ operator uint64_t()

utl::BitArrayElem::operator uint64_t ( ) const
inline

Conversion to uint64_t.

Definition at line 95 of file BitArrayElem.h.

◆ operator bool()

utl::BitArrayElem::operator bool ( ) const
inline

Conversion to bool.

Definition at line 101 of file BitArrayElem.h.

◆ operator==() [1/4]

bool utl::BitArrayElem::operator== ( bool  rhs) const
inline

Equal-to operator.

Definition at line 110 of file BitArrayElem.h.

◆ operator!=() [1/4]

bool utl::BitArrayElem::operator!= ( bool  rhs) const
inline

Unequal-to operator.

Definition at line 115 of file BitArrayElem.h.

◆ operator<() [1/3]

bool utl::BitArrayElem::operator< ( uint64_t  rhs) const
inline

Less-than operator.

Definition at line 121 of file BitArrayElem.h.

◆ operator<=() [1/3]

bool utl::BitArrayElem::operator<= ( uint64_t  rhs) const
inline

Less-than-or-equal-to operator.

Definition at line 126 of file BitArrayElem.h.

◆ operator>() [1/3]

bool utl::BitArrayElem::operator> ( uint64_t  rhs) const
inline

Greater-than operator.

Definition at line 131 of file BitArrayElem.h.

◆ operator>=() [1/3]

bool utl::BitArrayElem::operator>= ( uint64_t  rhs) const
inline

Greater-than-or-equal-to operator.

Definition at line 136 of file BitArrayElem.h.

◆ operator==() [2/4]

bool utl::BitArrayElem::operator== ( uint64_t  rhs) const
inline

Equal-to operator.

Definition at line 141 of file BitArrayElem.h.

◆ operator!=() [2/4]

bool utl::BitArrayElem::operator!= ( uint64_t  rhs) const
inline

Unequal-to operator.

Definition at line 146 of file BitArrayElem.h.

◆ operator<() [2/3]

bool utl::BitArrayElem::operator< ( int64_t  rhs) const
inline

Less-than operator.

Definition at line 152 of file BitArrayElem.h.

◆ operator<=() [2/3]

bool utl::BitArrayElem::operator<= ( int64_t  rhs) const
inline

Less-than-or-equal-to operator.

Definition at line 157 of file BitArrayElem.h.

◆ operator>() [2/3]

bool utl::BitArrayElem::operator> ( int64_t  rhs) const
inline

Greater-than operator.

Definition at line 162 of file BitArrayElem.h.

◆ operator>=() [2/3]

bool utl::BitArrayElem::operator>= ( int64_t  rhs) const
inline

Greater-than-or-equal-to operator.

Definition at line 167 of file BitArrayElem.h.

◆ operator==() [3/4]

bool utl::BitArrayElem::operator== ( int64_t  rhs) const
inline

Equal-to operator.

Definition at line 172 of file BitArrayElem.h.

◆ operator!=() [3/4]

bool utl::BitArrayElem::operator!= ( int64_t  rhs) const
inline

Unequal-to operator.

Definition at line 177 of file BitArrayElem.h.

◆ operator<() [3/3]

bool utl::BitArrayElem::operator< ( const BitArrayElem &  rhs) const
inline

Less-than operator.

Definition at line 183 of file BitArrayElem.h.

References get().

◆ operator<=() [3/3]

bool utl::BitArrayElem::operator<= ( const BitArrayElem &  rhs) const
inline

Less-than-or-equal-to operator.

Definition at line 188 of file BitArrayElem.h.

References get().

◆ operator>() [3/3]

bool utl::BitArrayElem::operator> ( const BitArrayElem &  rhs) const
inline

Greater-than operator.

Definition at line 193 of file BitArrayElem.h.

References get().

◆ operator>=() [3/3]

bool utl::BitArrayElem::operator>= ( const BitArrayElem &  rhs) const
inline

Greater-than-or-equal-to operator.

Definition at line 198 of file BitArrayElem.h.

References get().

◆ operator==() [4/4]

bool utl::BitArrayElem::operator== ( const BitArrayElem &  rhs) const
inline

Equal-to operator.

Definition at line 203 of file BitArrayElem.h.

References get().

◆ operator!=() [4/4]

bool utl::BitArrayElem::operator!= ( const BitArrayElem &  rhs) const
inline

Unequal-to operator.

Definition at line 208 of file BitArrayElem.h.

References get().


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