Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

PLDataSink Class Reference

This is a base class for a destination of picture data. More...

#include <pldatasink.h>

Inheritance diagram for PLDataSink:

Inheritance graph
[legend]
Collaboration diagram for PLDataSink:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void Open (const char *pszName, PLBYTE *pData, size_t MaxDataSize)
virtual void Close ()
char * GetName ()
PLBYTEGetBufferPtr ()
size_t GetDataSize ()
size_t GetMaxDataSize ()
size_t WriteNBytes (size_t n, PLBYTE *pData)
void WriteByte (PLBYTE Data)
void Skip (size_t n)
void CheckEOF ()
 Test to see if we didn't go past the "end of the file".

Protected Member Functions

 PLDataSink ()
virtual ~PLDataSink ()

Protected Attributes

PLBYTEm_pStartData
int m_nCurPos

Private Attributes

char * m_pszName
size_t m_nMaxFileSize

Friends

class PLTIFFEncoder
class PLTIFFEncoderEx

Detailed Description

This is a base class for a destination of picture data.

It defines methods to open, write to, close data sinks.

Restriction: actually writes to a memory buffer that needs to be foreseen large enough by user (descendant class)

Definition at line 25 of file pldatasink.h.


Constructor & Destructor Documentation

PLDataSink::PLDataSink  )  [protected]
 

Definition at line 20 of file pldatasink.cpp.

References NULL.

PLDataSink::~PLDataSink  )  [protected, virtual]
 

Definition at line 31 of file pldatasink.cpp.


Member Function Documentation

void PLDataSink::CheckEOF  )  [inline]
 

Test to see if we didn't go past the "end of the file".

Definition at line 116 of file pldatasink.h.

References PL_ERREND_OF_FILE.

void PLDataSink::Close  )  [virtual]
 

Reimplemented in PLFileSink, and PLMemSink.

Definition at line 59 of file pldatasink.cpp.

Referenced by PLMemSink::Close(), and PLFileSink::Close().

PLBYTE * PLDataSink::GetBufferPtr  )  [inline]
 

Definition at line 97 of file pldatasink.h.

size_t PLDataSink::GetDataSize  )  [inline]
 

Definition at line 109 of file pldatasink.h.

Referenced by PLFileSink::Close().

size_t PLDataSink::GetMaxDataSize  )  [inline]
 

Definition at line 103 of file pldatasink.h.

char * PLDataSink::GetName  ) 
 

Definition at line 69 of file pldatasink.cpp.

Referenced by PLPNGEncoder::DoEncode().

void PLDataSink::Open const char *  pszName,
PLBYTE pData,
size_t  MaxDataSize
 

Definition at line 40 of file pldatasink.cpp.

References PLASSERT, and PLBYTE.

Referenced by PLMemSink::Open(), and PLFileSink::Open().

void PLDataSink::Skip size_t  n  )  [inline]
 

Definition at line 127 of file pldatasink.h.

void PLDataSink::WriteByte PLBYTE  Data  ) 
 

Definition at line 89 of file pldatasink.cpp.

References PLBYTE.

size_t PLDataSink::WriteNBytes size_t  n,
PLBYTE pData
 

Definition at line 75 of file pldatasink.cpp.

References PL_ERREND_OF_FILE, and PLBYTE.

Referenced by EncodeData(), jpeg_mem_dest_empty_output_buffer(), and jpeg_mem_dest_term().


Friends And Related Function Documentation

friend class PLTIFFEncoder [friend]
 

Definition at line 29 of file pldatasink.h.

friend class PLTIFFEncoderEx [friend]
 

Definition at line 30 of file pldatasink.h.


Member Data Documentation

int PLDataSink::m_nCurPos [protected]
 

Definition at line 80 of file pldatasink.h.

Referenced by PLTIFFEncoderEx::Associate(), and PLTIFFEncoder::DoEncode().

size_t PLDataSink::m_nMaxFileSize [private]
 

Definition at line 92 of file pldatasink.h.

Referenced by PLTIFFEncoderEx::Associate(), and PLTIFFEncoder::DoEncode().

PLBYTE* PLDataSink::m_pStartData [protected]
 

Definition at line 79 of file pldatasink.h.

Referenced by PLTIFFEncoderEx::Associate(), and PLTIFFEncoder::DoEncode().

char* PLDataSink::m_pszName [private]
 

Definition at line 91 of file pldatasink.h.


The documentation for this class was generated from the following files:
Generated on Wed Dec 15 21:20:59 2004 for vuVolume by  doxygen 1.3.9.1