Class: TSortedSequenceOf

Declaration: SortedSequenceOf.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSequenceOf

Inherited By:

None.

Purpose:

TSortedSequenceOf is a template class that you can use to create collections of sorted objects. You can specify the mechanism used for ordering the collection. TSortedSequenceOf inherits operators for adding, removing, querying, counting and iterating the objects in the collection. TSortedSequenceOf also inherits operators for accessing the collection as a linked list. Iterators on TSortedSequenceOf return objects in order.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TSortedSequenceOf.

Concurrency:

Not multithread safe.

Resource Use:

The amount of memory used by objects of this class depends on the initial size of the collection, the number of objects it contains and how much you attempt to increase the collection's size.

Other Considerations:

None.

Member Function: TSortedSequenceOf::TSortedSequenceOf

TSortedSequenceOf ()
TSortedSequenceOf (const TSortedSequenceOf < AType > &)
TSortedSequenceOf (TOrderedComparator < AType > * adoptedComparator, TStreamer < AType > * adoptedStreamer)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Creates a TSortedSequenceOf, initializing the comparator and streamer objects to the specified arguments.

Calling Context:

Call this function directly anywhere the creation of a TSortedSequenceOf is desired.
Call this function directly to copy an object.
Call this function directly to create a collection with the specified comparator and streamer objects.

Parameters:

Takes no parameters.
const TSortedSequenceOf < AType > & -The object to be copied.
TOrderedComparator < AType > * adoptedComparator -The comparator object.
TStreamer < AType > * adoptedStreamer -The streamer object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSortedSequenceOf::~TSortedSequenceOf

virtual ~ TSortedSequenceOf ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSortedSequenceOf::operator=

const TSortedSequenceOf < AType > & operator =(const TSortedSequenceOf < AType > &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly when an object is assigned to another compatible object.

Parameters:

const TSortedSequenceOf < AType > & -The object to be copied.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSortedSequenceOf::operator==

bool operator ==(const TSortedSequenceOf < AType > & sortedSequenceOf) const

Interface Category:

API.

Purpose:

Compares the contents of this collection with the contents of another collection.

Calling Context:

Call this function directly to compare the equivalence of two objects on either side of the ==symbol.

Parameters:

const TSortedSequenceOf < AType > & sortedSequenceOf -The collection to compare to this collection.

Return Value:

Returns true if the contents of this collection are equivalent to the contents of the other collection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSortedSequenceOf::operator!=

bool operator != (const TSortedSequenceOf < AType > & sortedSequenceOf) const

Interface Category:

API.

Purpose:

Compares the contents of this collection with the contents of another collection.

Calling Context:

Call this function directly to compare the equivalence of two objects on either side of the != symbol.

Parameters:

const TSortedSequenceOf < AType > & sortedSequenceOf -The collection to compare to this collection.

Return Value:

Returns true if the contents of this collection are not equivalent to the contents of the other collection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.