libUTL++
utl::TRandIt< T > Class Template Referencefinal

Templated proxy for RandIt. More...

#include <TRandIt.h>

Inheritance diagram for utl::TRandIt< T >:

Public Member Functions

 TRandIt (RandIt *it)
 Constructor. More...
 
virtual int compare (const Object &rhs) const
 Compare with another iterator. More...
 
virtual void copy (const Object &rhs)
 Copy another iterator.
 
virtual void steal (Object &rhs)
 "Steal" the internal representation from another instance. More...
 
virtual const ObjectgetProxiedObject () const
 Get the proxied object (= self if none). More...
 
virtual ObjectgetProxiedObject ()
 Get the proxied object (= self if none). More...
 
virtual void forward (size_t dist=1)
 Move forward the given number of objects. More...
 
virtual void reverse (size_t dist=1)
 Move backward the given number of objects. More...
 
virtual void seek (size_t offset)
 Seek to the given offset. More...
 
virtual T * get () const
 Get the current object. More...
 
virtual T * get (size_t offset) const
 Get the object at the given offset. More...
 
virtual size_t offset () const
 Get the current offset. More...
 
virtual void set (size_t offset, const Object *object)
 Set the object at the given offset. More...
 
virtual void set (const Object *object)
 Set the current object. More...
 
virtual size_t size () const
 Return the current size of the sequence. More...
 
virtual size_t subtract (const RandIt &it) const
 Determine the distance between self and another random-access iterator for the same sequence. More...
 
RandItiterator () const
 Get the proxied iterator. More...
 
void setIt (RandIt *it)
 Set the iterator. More...
 
T * operator* () const
 Pointer dereference operator – return a T* instead of an Object*. More...
 
TRandItoperator= (RandIt *it)
 Set the iterator. More...
 
- Public Member Functions inherited from utl::RandIt
size_t operator- (const RandIt &it) const
 Provides a user-friendly interface to subtract(). More...
 
Objectoperator[] (size_t offset) const
 Provides a user-friendly interface to get(). More...
 
- Public Member Functions inherited from utl::BidIt
BidItoperator-- ()
 Pre-decrement operator. More...
 
void operator-- (int)
 Post-decrement operator. More...
 
BidItoperator-= (size_t dist)
 Decrement operator. More...
 
- Public Member Functions inherited from utl::FwdIt
bool isConst () const
 Get the const flag. More...
 
void setConst (bool p_const)
 Set the const flag. More...
 
virtual bool isEnd () const
 Determine whether the iterator points to the end of the sequence. More...
 
Objectoperator* () const
 Pointer dereference operator. More...
 
FwdItoperator++ ()
 Pre-increment operator. More...
 
void operator++ (int)
 Post-increment operator. More...
 
FwdItoperator+= (size_t dist)
 Increment operator. More...
 
bool isValid (const utl::Object *owner=nullptr) const
 Assert that the iterator is valid. More...
 
void invalidate () const
 Invalidate the iterator. More...
 
bool hasSameOwner (const FwdIt *it) const
 Query if self has the same owner as the given iterator. More...
 
const Objectowner () const
 Get the owner. More...
 
void setOwner (const Object *owner, bool notifyOwner=true) const
 Set the owner. 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 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 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 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

template<class T = Object>
class utl::TRandIt< T >

Templated proxy for RandIt.

TRandIt is a template version of RandIt that provides ease of use by reducing the need to perform typecasts. It acts as a proxy for a random access iterator (RandIt), returning (T*) instead of (Object*) where appropriate.

Author
Adam McKee

Definition at line 19 of file TRandIt.h.

Constructor & Destructor Documentation

◆ TRandIt()

template<class T = Object>
utl::TRandIt< T >::TRandIt ( RandIt it)
inline

Constructor.

Parameters
ititerator to proxy for

Definition at line 28 of file TRandIt.h.

References utl::compare(), and utl::copy().

Member Function Documentation

◆ compare()

template<class T >
int utl::TRandIt< T >::compare ( const Object rhs) const
virtual

Compare with another iterator.

The default implementation performs the comparison by comparing the objects referred to by each iterator (as determined by calling get()).

Reimplemented from utl::FwdIt.

Definition at line 181 of file TRandIt.h.

References utl::compareNullable().

◆ steal()

template<class T >
void utl::TRandIt< T >::steal ( Object rhs)
virtual

"Steal" the internal representation from another instance.

The default implementation just calls vclone(), so you have to override this if you want a "move" capability.

Reimplemented from utl::Object.

Definition at line 219 of file TRandIt.h.

References utl::Object::steal(), and UTL_CLASS_IMPL_TPL.

◆ getProxiedObject() [1/2]

template<class T = Object>
virtual const Object& utl::TRandIt< T >::getProxiedObject ( ) const
inlinevirtual

Get the proxied object (= self if none).

Reimplemented from utl::Object.

Definition at line 40 of file TRandIt.h.

◆ getProxiedObject() [2/2]

template<class T = Object>
virtual Object& utl::TRandIt< T >::getProxiedObject ( )
inlinevirtual

Get the proxied object (= self if none).

Reimplemented from utl::Object.

Definition at line 46 of file TRandIt.h.

◆ forward()

template<class T = Object>
virtual void utl::TRandIt< T >::forward ( size_t  dist = 1)
inlinevirtual

Move forward the given number of objects.

If the end of the sequence is reached, forward movement will stop without error.

Parameters
distdistance to move forward

Implements utl::FwdIt.

Definition at line 52 of file TRandIt.h.

◆ reverse()

template<class T = Object>
virtual void utl::TRandIt< T >::reverse ( size_t  dist = 1)
inlinevirtual

Move backward the given number of objects.

If the beginning of the sequence is reached, backward movement will stop without error.

Parameters
distdistance to move backward

Implements utl::BidIt.

Definition at line 58 of file TRandIt.h.

◆ seek()

template<class T = Object>
virtual void utl::TRandIt< T >::seek ( size_t  offset)
inlinevirtual

Seek to the given offset.

Implements utl::RandIt.

Definition at line 64 of file TRandIt.h.

◆ get() [1/2]

template<class T = Object>
virtual T* utl::TRandIt< T >::get ( ) const
inlinevirtual

Get the current object.

Returns
current object (nullptr if at end of sequence)

Implements utl::RandIt.

Definition at line 70 of file TRandIt.h.

◆ get() [2/2]

template<class T = Object>
virtual T* utl::TRandIt< T >::get ( size_t  offset) const
inlinevirtual

Get the object at the given offset.

Returns
found object (nullptr if offset is >= end)
Parameters
offsetposition of object within sequence

Implements utl::RandIt.

Definition at line 76 of file TRandIt.h.

◆ offset()

template<class T = Object>
virtual size_t utl::TRandIt< T >::offset ( ) const
inlinevirtual

Get the current offset.

Implements utl::RandIt.

Definition at line 82 of file TRandIt.h.

◆ set() [1/2]

template<class T = Object>
virtual void utl::TRandIt< T >::set ( size_t  offset,
const Object object 
)
inlinevirtual

Set the object at the given offset.

This method may not be called when the "const" flag is true. If there is already an object at offset, it will be replaced by the given object (or removed if object == nullptr). If offset refers to the end of the sequence, the given object will be added to the sequence.

Parameters
offsetposition within sequence
objectobject to put at offset

Implements utl::RandIt.

Definition at line 88 of file TRandIt.h.

◆ set() [2/2]

template<class T = Object>
virtual void utl::TRandIt< T >::set ( const Object object)
inlinevirtual

Set the current object.

This method may not be called when the const flag is true. If self points to an object, it will be replaced by the given object (or removed if object == nullptr). If self points to the end of the sequence, the given object will be added to the sequence.

Parameters
objectobject to put at current position

Implements utl::RandIt.

Definition at line 94 of file TRandIt.h.

◆ size()

template<class T = Object>
virtual size_t utl::TRandIt< T >::size ( ) const
inlinevirtual

Return the current size of the sequence.

Implements utl::RandIt.

Definition at line 100 of file TRandIt.h.

◆ subtract()

template<class T = Object>
virtual size_t utl::TRandIt< T >::subtract ( const RandIt it) const
inlinevirtual

Determine the distance between self and another random-access iterator for the same sequence.

This is calculated simply as the difference between the current offsets of the two iterators.

Returns
self.offset() - it.offset()
Parameters
ititerator to compare with

Reimplemented from utl::RandIt.

Definition at line 106 of file TRandIt.h.

◆ iterator()

template<class T = Object>
RandIt* utl::TRandIt< T >::iterator ( ) const
inline

Get the proxied iterator.

Returns
proxied iterator

Definition at line 116 of file TRandIt.h.

◆ setIt()

template<class T = Object>
void utl::TRandIt< T >::setIt ( RandIt it)
inline

Set the iterator.

Parameters
ititerator to proxy for.

Definition at line 126 of file TRandIt.h.

◆ operator*()

template<class T = Object>
T* utl::TRandIt< T >::operator* ( ) const
inline

Pointer dereference operator – return a T* instead of an Object*.

See also
get

Definition at line 139 of file TRandIt.h.

◆ operator=()

template<class T = Object>
TRandIt& utl::TRandIt< T >::operator= ( RandIt it)
inline

Set the iterator.

See also
setIt

Definition at line 148 of file TRandIt.h.

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


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