DWFToolkit::OPCZipFileReader Class Reference

#include "dwf/opc/ZipFileReader.h"

Inheritance diagram for DWFToolkit::OPCZipFileReader:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::OPCZipFileReader:

Collaboration graph
[legend]
List of all members.

Detailed Description

The OPCZipFileReader provides an implementation of the OPCPhysicalLayerReader interface for reading OPC documents. In particular, it is for reading from files, in which random access is available. It is NOT intended for streamed reading.

Since:
7.4.0
The OPCPhysicalLayerReader defines the interface for reading OPC documents.

Definition at line 49 of file ZipFileReader.h.

Public Member Functions

_DWFTK_API OPCZipFileReader (DWFZipFileDescriptor *pZipFileDescr) throw ()
virtual _DWFTK_API ~OPCZipFileReader () throw ()
virtual _DWFTK_API void open () throw (DWFException)
virtual _DWFTK_API DWFInputStreamread (const DWFString &zName) throw (DWFException)
virtual _DWFTK_API DWFInputStreamread (const DWFString &zName, bool bAutoDestroy) throw (DWFException)
virtual _DWFTK_API void close () throw (DWFException)
virtual _DWFTK_API void notifyOwnerChanged (DWFOwnable &rOwnable) throw ( DWFException )
virtual _DWFTK_API void notifyOwnableDeletion (DWFOwnable &rOwnable) throw ( DWFException )

Protected Attributes

DWFZipFileDescriptor_pZipFileDescr
bool _bOwnZipFileDescriptor


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::OPCZipFileReader::OPCZipFileReader DWFZipFileDescriptor pZipFileDescr  )  throw ()
 

Constructor

Parameters:
pZipFileDescr A pointer to a DWFZipFileDescriptor describing the zip package to be read from.
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::OPCZipFileReader::~OPCZipFileReader  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::OPCZipFileReader::close  )  throw (DWFException) [virtual]
 

Closes the archive.

Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::OPCZipFileReader::notifyOwnableDeletion DWFOwnable rOwnable  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API void DWFToolkit::OPCZipFileReader::notifyOwnerChanged DWFOwnable rOwnable  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API void DWFToolkit::OPCZipFileReader::open  )  throw (DWFException) [virtual]
 

Opens the archive.

Exceptions:
DWFException 

virtual _DWFTK_API DWFInputStream* DWFToolkit::OPCZipFileReader::read const DWFString zName,
bool  bAutoDestroy
throw (DWFException) [virtual]
 

Returns a stream from which the specified entity can be extracted from the archive.

Parameters:
zName The name of the section/part to read.
bAutoDestroy If true this object will be deleted when the stream is deleted.

virtual _DWFTK_API DWFInputStream* DWFToolkit::OPCZipFileReader::read const DWFString zName  )  throw (DWFException) [virtual]
 

Returns a stream from which the specified entity can be extracted from the archive.

Parameters:
zName The name of the entity to be read from the archive.
Returns:
A pointer to a stream from which the file can be read. The caller must delete this pointer using the DWFCORE_FREE_OBJECT macro.
Exceptions:
DWFException 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:27 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5