Class: TSample8PageImpositionSequencer

Declaration: PageCompositor.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPageImpositionSequencer

Inherited By:

None.

Purpose:

A sample Imposition Sequencer that does an eight-page double-sided booklet on one sheet.

Instantiation:

Always allocate on the heap so that it can be adopted readily.

Deriving Classes:

This is a sample imposition sequencer and is not intended to be derived. To add or obtain different behavior in a sequencer, derive directly from TPageImpositionSequencer.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSample8PageImpositionSequencer::TSample8PageImpositionSequencer

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TSample8PageImpositionSequencer & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::~TSample8PageImpositionSequencer

virtual ~ TSample8PageImpositionSequencer ()

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: TSample8PageImpositionSequencer::GetPageFrequency

virtual TULongPair GetPageFrequency () const

Interface Category:

API.

Purpose:

Sample sequencer.

Calling Context:

Called directly to get page frequency. Also called by any page impositor object containing this object.

Parameters:

Takes no parameters.

Return Value:

Returns the page frequency.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::NumberOfPagesPerSheetSide

virtual unsigned long NumberOfPagesPerSheetSide () const

Interface Category:

API.

Purpose:

Gets the number of pages on a sheet side.

Calling Context:

Called directly to get the number of pages to be printed on a sheet. Also called by any page impositor object containing this object.

Parameters:

Takes no parameters.

Return Value:

Returns the number of pages per sheet.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::DoubleSided

virtual bool DoubleSided () const

Interface Category:

API.

Purpose:

Tells whether sheets should be printed on both sides.

Calling Context:

Called directly to test for printing double sided. Also called by any page impositor object containing this object.

Parameters:

Takes no parameters.

Return Value:

Returns true if the imposition is double sided.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::SetNumberOfSheetsPerSection

virtual void SetNumberOfSheetsPerSection (unsigned long)

Interface Category:

API.

Purpose:

Sets the number of sheets in a section.

Calling Context:

Called directly to set the number of sheets per section. Also called by any page impositor object containing this object.

Parameters:

unsigned long -The imposition step sequence number. This is just the step sequence for the imposition mapping that defaults to TScanOrderRightDown as viewed from the destination page. This means that as the imposition sheet is composed, its source pages are always printed on the output sheet from left to right and top to bottom, irrespective of the order pages appear to the viewer.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::NumberOfSheetsPerSection

virtual unsigned long NumberOfSheetsPerSection () const

Interface Category:

API.

Purpose:

Returns the number of sheets per section.

Calling Context:

Called directly to get the number of sheets per section. Also called by any page impositor object containing this object.

Parameters:

Takes no parameters.

Return Value:

Returns the number of sheets per section.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::TotalNumberOfPagesPerSection

virtual unsigned long TotalNumberOfPagesPerSection () const

Interface Category:

API.

Purpose:

Totals the number of pages in a section.

Calling Context:

Called directly to get the total number of source pages in a section. Also called by any page impositor object containing this object.

Parameters:

Takes no parameters.

Return Value:

Returns total number of source pages per section.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::SourcePageNumber

virtual unsigned long SourcePageNumber (unsigned long) const

Interface Category:

API.

Purpose:

Returns the source page number for a given sequence number in the imposition.

Calling Context:

Called directly to get the required source page for a given step. Also called by any page impositor object containing this object.

Parameters:

unsigned long -The imposition step sequence number. This is just the step sequence for the imposition mapping that defaults to TScanOrderRightDown as viewed from the destination page. This means that as the imposition sheet is composed, its source pages are always printed on the output sheet from left to right and top to bottom, irrespective of the order pages appear to the viewer.

Return Value:

Returns the source page number required.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::Rotation

virtual GDegrees Rotation (unsigned long) const

Interface Category:

API.

Purpose:

Returns the rotation required for proper orientation of the page.

Calling Context:

Called directly to get the proper orientation. Also called by any page impositor object containing this object.

Parameters:

unsigned long -The imposition step sequence number. This is just the step sequence for the imposition mapping that defaults to TScanOrderRightDown as viewed from the destination page. This means that as the imposition sheet is composed, its source pages are always printed on the output sheet from left to right and top to bottom, irrespective of the order pages appear to the viewer.

Return Value:

Returns the orientation.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::Sequence

virtual unsigned long Sequence (GDegrees & rotation, unsigned long) const

Interface Category:

API.

Purpose:

Returns both the rotation and source page number required.

Calling Context:

Called directly to get both the rotation and page number. Also called by any page impositor object containing this object.

Parameters:

GDegrees & rotation -The amount of rotation needed for this step.
unsigned long -The imposition step sequence number. This is just the step sequence for the imposition mapping that defaults to TScanOrderRightDown as viewed from the destination page. This means that as the imposition sheet is composed, its source pages are always printed on the output sheet from left to right and top to bottom, irrespective of the order pages appear to the viewer.

Return Value:

Returns the source page required.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::Creep

virtual TGPoint Creep (unsigned long) const

Interface Category:

API.

Purpose:

Specifies the creep required.

Calling Context:

Called directly to get the creep adjustment. Also called by any page impositor object containing this object.

Parameters:

unsigned long -The imposition step sequence number. This is just the step sequence for the imposition mapping that defaults to TScanOrderRightDown as viewed from the destination page. This means that as the imposition sheet is composed, its source pages are always printed on the output sheet from left to right and top to bottom, irrespective of the order pages appear to the viewer.

Return Value:

Returns the creep adjustment.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::operator=

TSample8PageImpositionSequencer & operator =(const TSample8PageImpositionSequencer &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSample8PageImpositionSequencer & -The object from which to assign.

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: TSample8PageImpositionSequencer::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called directly to generate a hash value. Also called by the collection classes when this object is placed in a collection.

Parameters:

Takes no parameters.

Return Value:

Returns a hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSample8PageImpositionSequencer::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called directly to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself 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.

Member Function: TSample8PageImpositionSequencer::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called directly to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself 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.

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