DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DcmOutputBufferStream Class Reference

output stream that writes into a buffer of fixed length which must be provided by the caller. More...

+ Inheritance diagram for DcmOutputBufferStream:

Public Member Functions

 DcmOutputBufferStream (void *buf, offile_off_t bufLen)
 constructor More...
 
virtual ~DcmOutputBufferStream ()
 destructor
 
virtual void flushBuffer (void *&buffer, offile_off_t &length)
 retrieves and flushes the underlying buffer. More...
 
virtual offile_off_t filled ()
 query the number of bytes in buffer without flushing it. More...
 
- Public Member Functions inherited from DcmOutputStream
virtual ~DcmOutputStream ()
 destructor
 
virtual OFBool good () const
 returns the status of the stream. More...
 
virtual OFCondition status () const
 returns the status of the consumer as an OFCondition object. More...
 
virtual OFBool isFlushed () const
 returns true if the stream is flushed, i.e. More...
 
virtual offile_off_t avail () const
 returns the minimum number of bytes that can be written with the next call to write(). More...
 
virtual offile_off_t write (const void *buf, offile_off_t buflen)
 processes as many bytes as possible from the given input block. More...
 
virtual void flush ()
 instructs the stream to flush its internal content until either the stream becomes "flushed" or I/O suspension occurs. More...
 
virtual offile_off_t tell () const
 returns the total number of bytes written to the stream so far More...
 
virtual OFCondition installCompressionFilter (E_StreamCompression filterType)
 installs a compression filter for the given stream compression type, which should be neither ESC_none nor ESC_unsupported. More...
 

Private Member Functions

 DcmOutputBufferStream (const DcmOutputBufferStream &)
 private unimplemented copy constructor
 
DcmOutputBufferStreamoperator= (const DcmOutputBufferStream &)
 private unimplemented copy assignment operator
 

Private Attributes

DcmBufferConsumer consumer_
 the final consumer of the filter chain
 

Additional Inherited Members

- Protected Member Functions inherited from DcmOutputStream
 DcmOutputStream (DcmConsumer *initial)
 protected constructor, to be called from derived class constructor More...
 

Detailed Description

output stream that writes into a buffer of fixed length which must be provided by the caller.

Constructor & Destructor Documentation

DcmOutputBufferStream::DcmOutputBufferStream ( void *  buf,
offile_off_t  bufLen 
)

constructor

Parameters
bufbuffer in which data is stored. Must be allocated by caller and remain valid during the lifetime of this object.
bufLenbuffer length, must be even number > 0.

Member Function Documentation

virtual offile_off_t DcmOutputBufferStream::filled ( )
virtual

query the number of bytes in buffer without flushing it.

Returns
number of bytes in buffer.
virtual void DcmOutputBufferStream::flushBuffer ( void *&  buffer,
offile_off_t &  length 
)
virtual

retrieves and flushes the underlying buffer.

After return of this method, the buffer is considered to have been flushed (copied, stored) by the caller and is reused by the next write operation.

Parameters
bufferpointer to user provided buffer returned in this parameter
lengthnumber of bytes in buffer returned in this parameter

The documentation for this class was generated from the following file:


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8