All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

PrintBase Class CATPrintFileImage

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---PrintBase.CATPrintImage
        |
        +---CATPrintFileImage
 

Usage: you can derive this class.


public class CATPrintFileImage

Class to create print file images.


Constructor and Destructor Index


o CATPrintFileImage(CATPrintFileImage&)
Copy constructor.
o CATPrintFileImage(CATString&,CATString&)
Constructs a CATPrintFileImage from a file.
o CATPrintFileImage(char*,int,CATString&)
Constructs a CATPrintFileImage from memory.
o ~CATPrintFileImage()

Method Index


o Decode(CATPrintGenerator*,CATPrintParameters&)
Computes the print file image with the appropriate generator and parameters.
o Decode(CATPrintGenerator*,CATPrintParameters&,CATPrintDecodeType)
Computes the print file image with the appropriate generator and parameters.
o GetInterpreter(CATString&)
Allocates the interpreter associated to the language.
o GetSize(float&,float&)
Retrieves the size of the file image.
o GetTitle(CATUnicodeString&)
Returns the title of the image.

Constructor and Destructor


o CATPrintFileImage
public CATPrintFileImage( const CATPrintFileImage& iFileImage)
Copy constructor.
Parameters:
iFileImage
An existing CATPrintFileImage.
o CATPrintFileImage
public CATPrintFileImage( const CATString& iPath,
const CATString& iLanguage)
Constructs a CATPrintFileImage from a file.
Parameters:
iPath
The path of the file.
iLanguage
The language.
The available languages used in CATIA to create an image are "CGM", "TIFF", "RGB", "JPEG", "BMP" on both Windows and UNIX systems and "PICTURE" only on UNIX.
o CATPrintFileImage
public CATPrintFileImage( const char* iBuffer,
int iBufferSize,
const CATString& iLanguage)
Constructs a CATPrintFileImage from memory.
Parameters:
iBuffer
The buffer of memory.
iBufferSize
The size of the buffer.
iLanguage
The language.
The available languages used in CATIA to create an image are "CGM", "TIFF", "RGB", "JPEG", "BMP" on both Windows and UNIX systems and "PICTURE" only on UNIX.
o ~CATPrintFileImage
public virtual ~CATPrintFileImage()

Methods


o Decode
public int Decode(CATPrintGenerator* iGenerator,
const CATPrintParameters& iParameters)
Computes the print file image with the appropriate generator and parameters.
Parameters:
iGenerator
The generator.
iParameters
The print parameters.
Returns:
The status of the method.
Legal values: 0 -> KO, 1 -> OK.
o Decode
public virtual int Decode(CATPrintGenerator* iGenerator,
const CATPrintParameters& iParameters,
CATPrintDecodeType iDecodeType)
Computes the print file image with the appropriate generator and parameters.
Parameters:
iGenerator
The generator.
iParameters
The print parameters.
iDecodeType
This parameter indicates if this image will be added as a new image or into the same image.
Returns:
The status of the method.
Legal values: 0 -> KO, 1 -> OK.
o GetInterpreter
protected virtual void GetInterpreter( const CATString& iLanguage)
Allocates the interpreter associated to the language.
Parameters:
iLanguage
The language.
o GetSize
public int GetSize(float& oWidth,
float& oHeight)
Retrieves the size of the file image.
Parameters:
oWidth
The width of the image.
oHeight
The height of the image.
Returns:
The status of the method.
Legal values: 0 -> KO, 1 -> OK.
o GetTitle
public int GetTitle(CATUnicodeString& oTitle)
Returns the title of the image.
Returns:
The title of the image.

This object is included in the file: CATPrintFileImage.h
If needed, your Imakefile.mk should include the module: CATPrintBase

Copyright © 2003, Dassault Systèmes. All rights reserved.