utl::ExtArray Class Reference

Externally stored array of objects. More...

#include <ExtArray.h>

Inheritance diagram for utl::ExtArray:

Public Member Functions
	ExtArray (const String &baseName, const RunTimeClass *rtc=nullptr, uint_t serializeMode=uint_t_max)
	Constructor. More...
size_t	items () const
	Get number of items. More...
void	open (const String &baseName, const RunTimeClass *rtc=nullptr, uint_t serializeMode=ser_default)
	Open a new array. More...
void	close ()
	Close the currently open array. More...
void	add (const Object &object)
	Add an object. More...
Object *	get (size_t idx) const
	Get the object at the given index. More...
Object *	operator[] (size_t idx) const
	Get the object at the given index. 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	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...

Detailed Description

Externally stored array of objects.

ExtArray is intended for write-once/read-many (WORM) applications. Removal of objects isn't supported.

Author

Adam McKee

Definition at line 25 of file ExtArray.h.

Constructor & Destructor Documentation

ExtArray()

utl::ExtArray::ExtArray ( const String &  baseName, const RunTimeClass *  rtc = nullptr, uint_t  serializeMode = uint_t_max  )

inline

Constructor.

Parameters

baseName	base pathname for object and index files
rtc	class of all objects in the array (nullptr if unknown)
serializeMode	serialization mode (see utl::serialize_t)

Definition at line 36 of file ExtArray.h.

References utl::init().

Member Function Documentation

items()

size_t utl::ExtArray::items ( ) const

inline

Get number of items.

Definition at line 46 of file ExtArray.h.

References utl::ser_default.

open()

void utl::ExtArray::open	(	const String &	baseName,
		const RunTimeClass *	rtc = nullptr,
		uint_t	serializeMode = ser_default
	)

Open a new array.

Parameters

baseName	base pathname for object and index files
rtc	class of all objects in the array (nullptr if unknown)
serializeMode	serialization mode (see utl::serialize_t)

close()

void utl::ExtArray::close

(

)

Close the currently open array.

add()

void utl::ExtArray::add

(

const Object &

object

)

Add an object.

Parameters

object

object to add

get()

Object* utl::ExtArray::get

(

size_t

idx

)

const

Get the object at the given index.

The caller is responsible for deleting the returned object.

Returns

found object (nullptr if none)

Parameters

idx	array index

operator[]()

Object* utl::ExtArray::operator[] ( size_t  idx ) const

inline

Get the object at the given index.

Returns

found object (nullptr if none)

Parameters

idx	array index

Definition at line 83 of file ExtArray.h.

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

---

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

• ExtArray.h