IACollection

IACollection is an abstract class, therefore it cannot be used to create any objects. This class defines the base interfaces for the collection classes.


IACollection - Member Functions and Data by Group

Constructors & Destructor

IACollection is an abstract class, therefore you cannot create or destroy any objects of this class.


[view class]
~IACollection
public:
virtual ~IACollection()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IACollection


Overload 1
public:
IACollection(INotifier&)

Use this constructor to create a collection with support for notification.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
protected:
IACollection()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 3
protected:
IACollection(IACollection < Element > const&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Collection Status

Use these methods to test the status of the collection.


[view class]
isBounded
public:
bool isBounded() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isConsistent
public:
bool isConsistent() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isEmpty
public:
bool isEmpty() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isEnabledForNotification
public:
bool isEnabledForNotification() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isFull
public:
bool isFull() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
maxNumberOfElements
public:
INumber maxNumberOfElements() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
numberOfElements
public:
INumber numberOfElements() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Cursor Support

Methods used to access, add or remove elements using cursors.


[view class]
add
public:
virtual bool add(Element const&, ICursor&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
elementAt


Overload 1
public:
Element const& elementAt(ICursor const&) const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
Element& elementAt(ICursor const&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
removeAt
public:
virtual void removeAt(ICursor&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
replaceAt
public:
virtual void replaceAt(ICursor const&, Element const&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToFirst
public:
bool setToFirst(ICursor&) const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setToNext
public:
bool setToNext(ICursor&) const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Do For All Elements

These methods apply actions to all the elements of the collection.


[view class]
allElementsDo


Overload 1
public:
bool allElementsDo( bool ( * applicatorFunction ) ( Element&, void * ) , void* additionalArgument = 0 )

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
bool allElementsDo(IApplicator < Element >&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 3
public:
bool allElementsDo(IConstantApplicator < Element >&) const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 4
public:
bool allElementsDo( bool ( * applicatorFunction ) ( Element const&, void * ) , void* additionalArgument = 0 ) const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Element Access

Methods used to add, access or remove elements from the collection.


[view class]
add
public:
virtual bool add(Element const&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
addAllFrom
public:
virtual void addAllFrom(IACollection < Element > const&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
any
public:
Element const& any() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
anyElement
public:
Element const& anyElement() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
removeAll


Overload 1
public:
virtual INumber removeAll()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
virtual INumber removeAll( bool ( * predicateFunction ) ( Element const&, void * ) , void* additionalArgument = 0 )

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Miscellaneous


[view class]
copy
public:
virtual void copy(IACollection < Element > const&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator INotifier &
public:
operator INotifier &() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
ImplOf
protected:
static Implementation& ImplOf( IACollection < Element > const& )

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Notification Support


[view class]
disableNotification
public:
INotifier& disableNotification()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
enableNotification
public:
INotifier& enableNotification(bool = true)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
notifier


Overload 1
public:
INotifier& notifier()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
INotifier const& notifier() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
notifyObservers
public:
INotifier& notifyObservers(INotificationEvent const&)

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Streaming Support

These methods support streaming of elements to and from data streams.


[view class]
adoptStreamer
public:
void adoptStreamer(IACollectionStreamer*)

This method adopts a streamer object which is used to handle element streaming to and from a data stream.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator <<=
public:
virtual void operator <<=(IDataStream&)

Streams in the stored elements to this collection. The adopted streamer object is used to do the streaming.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator >>=
public:
virtual void operator >>=(IDataStream&)

Streams the elements of this collection out to the passed data stream. The adopted streamer object is used to do the element streaming.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Miscellaneous Members


[view class]
newCursor
public:
virtual ICursor* newCursor() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
newMngCursor
public:
ICursor* newMngCursor() const

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IACollection - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

IACollectionBase

Inherited Protected Data