ZeusBase-Library  2.0.4
zeus::ISet< T > Class Template Referenceabstract

#include <ISet.hpp>

Inheritance diagram for zeus::ISet< T >:
zeus::IValueType zeus::TSet< T >

Public Member Functions

virtual bool MQUALIFIER addItem (const T &rItem)=0
 
virtual void MQUALIFIER addAllItems (const ISet< T > &rItems)=0
 
virtual void MQUALIFIER addAllItemsFromList (const IList< T > &rList)=0
 
virtual void MQUALIFIER clear ()=0
 
virtual Int MQUALIFIER getCount () const =0
 
virtual bool MQUALIFIER hasItem (const T &rItem) const =0
 
virtual bool MQUALIFIER hasAllItems (const ISet< T > &rItems) const =0
 
virtual IListIterator< T > *MQUALIFIER getIterator ()=0
 
virtual const IListIterator< T > *MQUALIFIER getConstIterator () const =0
 
virtual bool MQUALIFIER isEmpty () const =0
 
virtual void MQUALIFIER releaseIterator (const IListIterator< T > *pIterator) const =0
 
virtual bool MQUALIFIER removeItem (const T &rItem)=0
 
virtual void MQUALIFIER removeAllItems (const ISet< T > &rItems)=0
 
virtual void MQUALIFIER copyToList (IList< T > &rList) const =0
 
virtual void MQUALIFIER copyToSet (ISet< T > &rSet) const =0
 
virtual bool MQUALIFIER equals (const ISet< T > &rSet) const =0
 
virtual T &MQUALIFIER getItem ()=0
 
virtual const T &MQUALIFIER getItemConst () const =0
 

Detailed Description

template<class T>
class zeus::ISet< T >

This class implements a set (using stl::set) for different types

Member Function Documentation

§ addAllItems()

template<class T>
virtual void MQUALIFIER zeus::ISet< T >::addAllItems ( const ISet< T > &  rItems)
pure virtual

adds all new items to the set

Parameters
rItems: Items to add

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ addAllItemsFromList()

template<class T>
virtual void MQUALIFIER zeus::ISet< T >::addAllItemsFromList ( const IList< T > &  rList)
pure virtual

Add all items from a list to this set.

Parameters
rList[IN]: The list.

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ addItem()

template<class T>
virtual bool MQUALIFIER zeus::ISet< T >::addItem ( const T &  rItem)
pure virtual

adds a new item to the set

Parameters
rItem: Item to add
Return values
true: Item added
falseItem is already added

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, zeus::TSet< zeus::TString >, and zeus::TManagedSet< T >.

§ clear()

template<class T>
virtual void MQUALIFIER zeus::ISet< T >::clear ( )
pure virtual

removes all items from the set

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ copyToList()

template<class T>
virtual void MQUALIFIER zeus::ISet< T >::copyToList ( IList< T > &  rList) const
pure virtual

Copies a set into a list

Parameters
rList: Target list

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ copyToSet()

template<class T>
virtual void MQUALIFIER zeus::ISet< T >::copyToSet ( ISet< T > &  rSet) const
pure virtual

Copies a set into a set

Parameters
rSet: Target set

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ equals()

template<class T>
virtual bool MQUALIFIER zeus::ISet< T >::equals ( const ISet< T > &  rSet) const
pure virtual

this method checks if two sets are equal

Parameters
rSet: set to check
Return values
true: Sets are equal
falsesets are not equal

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ getConstIterator()

template<class T>
virtual const IListIterator<T>* MQUALIFIER zeus::ISet< T >::getConstIterator ( ) const
pure virtual

returns a const set iterator. Release the iterator using releaseIterator() method

Returns
new const set iterator

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ getCount()

template<class T>
virtual Int MQUALIFIER zeus::ISet< T >::getCount ( ) const
pure virtual

returns the number of items

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ getItem()

template<class T>
virtual T& MQUALIFIER zeus::ISet< T >::getItem ( )
pure virtual

Returns an item of the set. Use the iterator to iterate throu the set and traverse all items. This method will just return one and the same item of the set

Returns
An item of the set

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ getItemConst()

template<class T>
virtual const T& MQUALIFIER zeus::ISet< T >::getItemConst ( ) const
pure virtual

§ getIterator()

template<class T>
virtual IListIterator<T>* MQUALIFIER zeus::ISet< T >::getIterator ( )
pure virtual

returns a set iterator. Release the iterator using releaseIterator() method

Returns
new set iterator

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ hasAllItems()

template<class T>
virtual bool MQUALIFIER zeus::ISet< T >::hasAllItems ( const ISet< T > &  rItems) const
pure virtual

Checks if all items of a set are included

Parameters
rItems: Items to check
Return values
true: All items are included
falseAt least one item is not included

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ hasItem()

template<class T>
virtual bool MQUALIFIER zeus::ISet< T >::hasItem ( const T &  rItem) const
pure virtual

Checks if an item is included

Parameters
rItem: Item to check
Return values
true: Item is included
falseItem is not included

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ isEmpty()

template<class T>
virtual bool MQUALIFIER zeus::ISet< T >::isEmpty ( ) const
pure virtual

Checks if the set is empty

Return values
true: Set is empty
falseSet is not empty

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ releaseIterator()

template<class T>
virtual void MQUALIFIER zeus::ISet< T >::releaseIterator ( const IListIterator< T > *  pIterator) const
pure virtual

Releases an iterator.

Parameters
pIterator: Iterator instance

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ removeAllItems()

template<class T>
virtual void MQUALIFIER zeus::ISet< T >::removeAllItems ( const ISet< T > &  rItems)
pure virtual

removes all given items from the set

Parameters
rItems: Item to remove

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.

§ removeItem()

template<class T>
virtual bool MQUALIFIER zeus::ISet< T >::removeItem ( const T &  rItem)
pure virtual

removes one item from the set

Parameters
rItem: Item to remove

Implemented in zeus::TSet< T >, zeus::TSet< TAutoPtr< T > >, and zeus::TSet< zeus::TString >.


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


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Tue Sep 13 2016 22:31:39