All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

PrintBase Class CATPrintStream

CATPrintStream
 

Usage: you must use this class as is. You should never derive it.


public class CATPrintStream

Class to manage i/o on typed file.

Role: This class is derived from fstream (C++ i/o lib).


Constructor and Destructor Index


o CATPrintStream()
Constructs a CATPrintStream.
o CATPrintStream(CATUnicodeString&,CATUnicodeString&,void*)
Constructs a CATPrintStream.
o ~CATPrintStream()

Method Index


o Close(void)
Closes the stream.
o GetLanguage(void)
Returns the language.
o GetPath(void)
Returns the path.
o GetPrivateData(void)
Returns the possible private data.
o OpenRead(void)
Opens the stream in read mode.
o OpenWrite(void)
Opens the stream in write mode.

Constructor and Destructor


o CATPrintStream
public CATPrintStream()
Constructs a CATPrintStream.
o CATPrintStream
public CATPrintStream( const CATUnicodeString& iPath,
const CATUnicodeString& iLanguage,
const void* iPrivateData= NULL)
Constructs a CATPrintStream.
Parameters:
iPath
The path of the stream.
iLanguage
The language of the stream.
iPrivateData
The possible private data to transmit.
o ~CATPrintStream
public virtual ~CATPrintStream()

Methods


o Close
public void Close(void )
Closes the stream.
o GetLanguage
public const CATUnicodeString& GetLanguage(void ) const
Returns the language.
Returns:
The language of the stream.
o GetPath
public const CATUnicodeString& GetPath(void ) const
Returns the path.
Returns:
The path of the stream.
o GetPrivateData
public const void* GetPrivateData(void ) const
Returns the possible private data.
Returns:
The possible private data.
o OpenRead
public int OpenRead(void )
Opens the stream in read mode.
Returns:
The status of the open in read mode.
Legal values: 0 -> KO, 1 -> OK.
o OpenWrite
public int OpenWrite(void )
Opens the stream in write mode.
Returns:
The status of the open in write mode.
Legal values: 0 -> KO, 1 -> OK.

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

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