Exiv2::Internal::TiffHeaderBase Class Reference

Abstract base class defining the interface of an image header. Used internally by classes for TIFF-based images. Default implementation is for the regular TIFF header. More...

#include <tiffimage_int.hpp>

Inheritance diagram for Exiv2::Internal::TiffHeaderBase:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Creators
 TiffHeaderBase (uint16_t tag, uint32_t size, ByteOrder byteOrder, uint32_t offset)
 Constructor taking tag, size and default byteOrder and offset.
virtual ~TiffHeaderBase ()=0
 Virtual destructor.
Manipulators
virtual bool read (const byte *pData, uint32_t size)
 Read the image header from a data buffer. Return false if the data buffer does not contain an image header of the expected format, else true.
virtual void setByteOrder (ByteOrder byteOrder)
 Set the byte order.
virtual void setOffset (uint32_t offset)
 Set the offset to the start of the root directory.
Accessors
virtual DataBuf write () const
 Return the image header in binary format. The caller owns this data and DataBuf ensures that it will be deleted.
virtual void print (std::ostream &os, const std::string &prefix="") const
 Print debug info for the image header to os.
virtual ByteOrder byteOrder () const
 Return the byte order (little or big endian).
virtual uint32_t offset () const
 Return the offset to the start of the root directory.
virtual uint32_t size () const
 Return the size (in bytes) of the image header.
virtual uint16_t tag () const
 Return the tag value (magic number) which identifies the buffer as TIFF data.

Detailed Description

Abstract base class defining the interface of an image header. Used internally by classes for TIFF-based images. Default implementation is for the regular TIFF header.


Member Function Documentation

void Exiv2::Internal::TiffHeaderBase::print std::ostream &  os,
const std::string &  prefix = ""
const [virtual]
 

Print debug info for the image header to os.

Parameters:
os Output stream to write to.
prefix Prefix to be written before each line of output.

bool Exiv2::Internal::TiffHeaderBase::read const byte pData,
uint32_t  size
[virtual]
 

Read the image header from a data buffer. Return false if the data buffer does not contain an image header of the expected format, else true.

Parameters:
pData Pointer to the data buffer.
size Number of bytes in the data buffer.
Returns:
True if the TIFF header was read successfully. False if the data buffer does not contain a valid TIFF header.

Reimplemented in Exiv2::Internal::Cr2Header, and Exiv2::Internal::OrfHeader.

DataBuf Exiv2::Internal::TiffHeaderBase::write  )  const [virtual]
 

Return the image header in binary format. The caller owns this data and DataBuf ensures that it will be deleted.

Returns:
Binary header data.

Reimplemented in Exiv2::Internal::Cr2Header, Exiv2::Internal::OrfHeader, and Exiv2::Internal::Rw2Header.


The documentation for this class was generated from the following files:
Generated on Thu Dec 31 03:58:25 2009 for Exiv2 by  doxygen 1.3.9.1