Class: TPrintJobCollection

Declaration: Printer.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TPrintJobCollection is a type safe collection of TPrintJobHandles. This class exists only because the current TCollections can contain any derived classes of MCollectible. TPrintJobCollection supports TDeque protocol. The only difference between it and a TDeque is that TPrintJobCollection accepts only TPrintJobHandles for the collection and it owns TPrintJobHandles added to it.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Not expected to be derived from.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPrintJobCollection::TPrintJobCollection

TPrintJobCollection ()
TPrintJobCollection (const TPrintJobCollection &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TPrintJobCollection & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::~TPrintJobCollection

virtual ~ TPrintJobCollection ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called 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: TPrintJobCollection::Add

virtual void Add (TPrintJobHandle * obj)

Interface Category:

API.

Purpose:

Adds a TPrintJobHandle to the collection.

Calling Context:

Called to add a TPrintJobHandle to the collection.

Parameters:

TPrintJobHandle * obj -The object to add.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::Delete

virtual void Delete (const TPrintJobHandle & obj)

Interface Category:

API.

Purpose:

Deletes the TPrintJobHandle matching the parameter from the collection.

Calling Context:

Call this function directly.

Parameters:

const TPrintJobHandle & obj -The object to match with.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::Remove

virtual TPrintJobHandle * Remove (const TPrintJobHandle & obj)

Interface Category:

API.

Purpose:

Removes the TPrintJobHandle matching the parameter from the collection and returns it. It is the client's responsibility to delete it.

Calling Context:

Call this function directly.

Parameters:

const TPrintJobHandle & obj -The object to match with.

Return Value:

Returns a pointer to TPrintJobHandle if a match is found in the list. Returns NIL otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::DeleteAll

virtual void DeleteAll ()

Interface Category:

API.

Purpose:

Deletes all TPrintJobHandles from the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::RemoveAll

virtual void RemoveAll ()

Interface Category:

API.

Purpose:

Removes and deletes all TPrintJobHandles from the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::Count

virtual long Count () const

Interface Category:

API.

Purpose:

Returns the number of TPrintJobHandles in the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::After

virtual TPrintJobHandle * After (const TPrintJobHandle & obj) const

Interface Category:

API.

Purpose:

Returns the TPrintJobHandle after the given one.

Calling Context:

Call this function directly.

Parameters:

const TPrintJobHandle & obj -Returns the TPrintJobHandle that appears after this object in the collection.

Return Value:

A pointer to a TPrintJobHandle. Clients do not own this pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::Before

virtual TPrintJobHandle * Before (const TPrintJobHandle & obj) const

Interface Category:

API.

Purpose:

Returns the TPrintJobHandle before the given one.

Calling Context:

Call this function directly.

Parameters:

const TPrintJobHandle & obj -Returns the TPrintJobHandle that appears before this object in the collection.

Return Value:

A pointer to a TPrintJobHandle. Clients do not own this pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::AddAfter

virtual void AddAfter (const TPrintJobHandle & existingobj, TPrintJobHandle * tobeadded)

Interface Category:

API.

Purpose:

Adds a TPrintJobHandle after the one specified.

Calling Context:

Call this function directly.

Parameters:

const TPrintJobHandle & existingobj -The existing TPrintJobHandle to match with.
TPrintJobHandle * tobeadded -The TPrintJobHandle to be added.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::AddBefore

virtual void AddBefore (const TPrintJobHandle & existingobj, TPrintJobHandle * tobeadded)

Interface Category:

API.

Purpose:

Adds a TPrintJobHandle before the one specified.

Calling Context:

Call this function directly.

Parameters:

const TPrintJobHandle & existingobj -The existing TPrintJobHandle to match with.
TPrintJobHandle * tobeadded -The TPrintJobHandle to be added.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::AddLast

virtual void AddLast (TPrintJobHandle * obj)

Interface Category:

API.

Purpose:

Adds a TPrintJobHandle at the end of the list.

Calling Context:

Call this function directly.

Parameters:

TPrintJobHandle * obj -The TPrintJobHandle to be added.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::AddFirst

virtual void AddFirst (TPrintJobHandle * obj)

Interface Category:

API.

Purpose:

Adds a TPrintJobHandle at the beginning of the list.

Calling Context:

Call this function directly.

Parameters:

TPrintJobHandle * obj -The TPrintJobHandle to be added.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::Last

virtual TPrintJobHandle * Last () const

Interface Category:

API.

Purpose:

Returns the last TPrintJobHandle in the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to a TPrintJobHandle. Clients do not own this pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::First

virtual TPrintJobHandle * First () const

Interface Category:

API.

Purpose:

Returns the first TPrintJobHandle in the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to a TPrintJobHandle. Clients do not own this pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::RemoveLast

virtual void RemoveLast ()

Interface Category:

API.

Purpose:

Deletes the last TPrintJobHandle form the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::RemoveFirst

virtual void RemoveFirst ()

Interface Category:

API.

Purpose:

Deletes the first TPrintJobHandle form the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::Member

virtual TPrintJobHandle * Member (const TPrintJobHandle & obj) const

Interface Category:

API.

Purpose:

Returns a pointer to the TPrintJobHandle in the list if one exists that matches the supplied TPrintJobHandle. Returns NIL otherwise.

Calling Context:

Call this function directly.

Parameters:

const TPrintJobHandle & obj -The object to match with.

Return Value:

A pointer to the TPrintJobHandle in the list if one exists that matches the supplied TPrintJobHandle. Returns NIL otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::CreatePrintJobIterator

virtual TPrintJobIterator * CreatePrintJobIterator () const

Interface Category:

API.

Purpose:

Creates an iterator for the collection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an iterator object that clients must delete when done.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::IsEmpty

virtual bool IsEmpty () const

Interface Category:

API.

Purpose:

Determines whether the list is empty.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if the list is empty, false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::operator=

TPrintJobCollection & operator =(const TPrintJobCollection &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TPrintJobCollection & -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPrintJobCollection::operator<<=

virtual TStream & operator <<= (TStream & towhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & towhere -The stream the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

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.