iMutableCollection Struct Reference

Inheritance diagram for iMutableCollection:

Detailed Description

Mutable Collection interface.

Public Member Functions
virtual tBool	Clear ()=0
	Removes all of the elements from this collection. More...
virtual tBool	Copy (const iCollection *apCollection)=0
	Copy a collection of the same type in this collection. More...
virtual tBool	Reserve (tU32 anSize)=0
	Reserve memory for the specified number of elements. More...
virtual tBool	Resize (tU32 anSize)=0
	Resize the collection to the specified number of elements. More...
virtual tBool	Add (const Var &aVar)=0
	Ensures that this collection contains the specified key. More...
virtual tBool	AddAll (const iCollection *apCollection)=0
	Adds all of the elements in the specified collection to this collection. More...
virtual tBool	Remove (const Var &aVar)=0
	Removes a single instance of the specified key from this collection, if it is present (optional operation). More...
virtual tBool	RemoveIterator (iIterator *apIterator)=0
	Removes the element pointed by the specified iterator. More...
virtual tBool	RemoveAll (const iCollection *apCollection)=0
	Removes all of this collection's elements that are also contained in the specified collection. More...
virtual tBool	RemoveFirst ()=0
	Retrieve and remove the first element of the container. More...
virtual tBool	RemoveLast ()=0
	Retrieve and remove the last element of the container. More...
virtual tBool	Put (const Var &aKey, const Var &aValue)=0
	Associates the specified value with the specified key. More...
virtual tBool	SetFirst (const Var &aValue)=0
	Sets the first value in the container. {Property}. More...
virtual tBool	SetLast (const Var &aValue)=0
	Sets the last value in the container. {Property}. More...
virtual tPtr	GetDataPtr () const =0
	Get a pointer to continous memory that can be read/written directly. More...
virtual tSize	GetDataSize () const =0
	Get the size in bytes of the memory pointed by the data pointer. More...
Public Member Functions inherited from iCollection
virtual tType	GetKeyType () const =0
	Get the collection's key type. {Property}. More...
virtual tType	GetValueType () const =0
	Get the collection's value type. {Property}. More...
virtual tBool	IsEmpty () const =0
	Returns true if this collection contains no elements. More...
virtual tU32	GetSize () const =0
	Returns the number of elements in this collection. More...
virtual tBool	Contains (const Var &aVar) const =0
	Returns true if this collection contains the specified key. More...
virtual tBool	ContainsAll (const iCollection *apCollection) const =0
	Returns true if this collection contains all of the elements in the specified collection. More...
virtual iIterator *	Iterator () const =0
	Returns an iterator over the elements in this collection. More...
virtual iIterator *	Find (const Var &aVar) const =0
	Returns an iterator over starting at the specified elements in this collection. More...
virtual Var	Get (const Var &aKey) const =0
	Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. More...
virtual Var	GetFirst () const =0
	Returns the first value in the container. {Property}. More...
virtual Var	GetLast () const =0
	Returns the last value in the container. {Property}. More...
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...
virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...
virtual tI32	Release ()=0
	Release a reference of the object. More...
virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...
virtual void	Invalidate ()=0
	Invalidate the object. More...
virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...
virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...
virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...
virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual tBool Clear ( )

pure virtual

Removes all of the elements from this collection.

virtual tBool Copy ( const iCollection *  apCollection )

pure virtual

Copy a collection of the same type in this collection.

Remarks

Invalidates all the iterators.

Returns

eFalse if the specified collection cannot be copied in this collection.

virtual tBool Reserve ( tU32  anSize )

pure virtual

Reserve memory for the specified number of elements.

virtual tBool Resize ( tU32  anSize )

pure virtual

Resize the collection to the specified number of elements.

virtual tBool Add ( const Var &  aVar )

pure virtual

Ensures that this collection contains the specified key.

virtual tBool AddAll ( const iCollection *  apCollection )

pure virtual

Adds all of the elements in the specified collection to this collection.

virtual tBool Remove ( const Var &  aVar )

pure virtual

Removes a single instance of the specified key from this collection, if it is present (optional operation).

virtual tBool RemoveIterator ( iIterator *  apIterator )

pure virtual

Removes the element pointed by the specified iterator.

virtual tBool RemoveAll ( const iCollection *  apCollection )

pure virtual

Removes all of this collection's elements that are also contained in the specified collection.

virtual tBool RemoveFirst ( )

pure virtual

Retrieve and remove the first element of the container.

virtual tBool RemoveLast ( )

pure virtual

Retrieve and remove the last element of the container.

virtual tBool Put ( const Var &  aKey, const Var &  aValue  )

pure virtual

Associates the specified value with the specified key.

virtual tBool SetFirst ( const Var &  aValue )

pure virtual

Sets the first value in the container. {Property}.

virtual tBool SetLast ( const Var &  aValue )

pure virtual

Sets the last value in the container. {Property}.

virtual tPtr GetDataPtr ( ) const

pure virtual

Get a pointer to continous memory that can be read/written directly.

Remarks

Optional

virtual tSize GetDataSize ( ) const

pure virtual

Get the size in bytes of the memory pointed by the data pointer.

Remarks

Optional