Exiv2::Internal::TiffEntryBase Class Reference

This abstract base class provides the common functionality of an IFD directory entry and defines an extended interface for derived concrete entries, which allows access to the attributes of the entry. More...

#include <tiffcomposite_int.hpp>

Inheritance diagram for Exiv2::Internal::TiffEntryBase:

Public Member Functions
Creators
	TiffEntryBase (uint16_t tag, IfdId group, TiffType tiffType=ttUndefined)
	Default constructor.
virtual	~TiffEntryBase ()
	Virtual destructor.
Manipulators
void	encode (TiffEncoder &encoder, const Exifdatum *datum)
	Encode a TIFF component from the metadatum provided and information from the encoder as needed. More...
void	setOffset (int32_t offset)
	Set the offset.
void	setData (byte *pData, int32_t size)
	Set pointer and size of the entry's data (not taking ownership of the data).
void	setData (DataBuf buf)
	Set the entry's data buffer, taking ownership of the data buffer passed in.
void	updateValue (Value::AutoPtr value, ByteOrder byteOrder)
	Update the value. Takes ownership of the pointer passed in. More...
void	setValue (Value::AutoPtr value)
	Set tag value. Takes ownership of the pointer passed in. More...
Accessors
TiffType	tiffType () const
	Return the TIFF type.
int32_t	offset () const
	Return the offset to the data area relative to the base for the component (usually the start of the TIFF header)
virtual int	idx () const
	Return the unique id of the entry in the image.
const byte *	pData () const
	Return a pointer to the binary representation of the value of this component.
const Value *	pValue () const
	Return a const pointer to the converted value of this component.
Public Member Functions inherited from Exiv2::Internal::TiffComponent
	TiffComponent (uint16_t tag, IfdId group)
	Constructor.
virtual	~TiffComponent ()
	Virtual destructor.
TiffComponent *	addPath (uint16_t tag, TiffPath &tiffPath, TiffComponent *const pRoot, AutoPtr object=AutoPtr(0))
	Add a TIFF entry tag to the component. Components on the path to the entry are added if they don't exist yet. More...
TiffComponent *	addChild (AutoPtr tiffComponent)
	Add a child to the component. Default is to do nothing. More...
TiffComponent *	addNext (AutoPtr tiffComponent)
	Add a "next" component to the component. Default is to do nothing. More...
void	accept (TiffVisitor &visitor)
	Interface to accept visitors (Visitor pattern). Visitors can perform operations on all components of the composite. More...
void	setStart (const byte *pStart)
	Set a pointer to the start of the binary representation of the component in a memory buffer. The buffer must be allocated and freed outside of this class.
uint32_t	write (IoWrapper &ioWrapper, ByteOrder byteOrder, int32_t offset, uint32_t valueIdx, uint32_t dataIdx, uint32_t &imageIdx)
	Write a TiffComponent to a binary image. More...
uint16_t	tag () const
	Return the tag of this entry.
IfdId	group () const
	Return the group id of this component.
byte *	start () const
	Return a pointer to the start of the binary representation of the component.
AutoPtr	clone () const
	Return an auto-pointer to a copy of itself (deep copy, but without any children). The caller owns this copy and the auto-pointer ensures that it will be deleted.
uint32_t	writeData (IoWrapper &ioWrapper, ByteOrder byteOrder, int32_t offset, uint32_t dataIdx, uint32_t &imageIdx) const
	Write the IFD data of this component to a binary image. Return the number of bytes written. Components derived from TiffEntryBase implement this method if needed.
uint32_t	writeImage (IoWrapper &ioWrapper, ByteOrder byteOrder) const
	Write the image data of this component to a binary image. Return the number of bytes written. TIFF components implement this method if needed.
uint32_t	size () const
	Return the size in bytes of the IFD value of this component when written to a binary image.
uint32_t	count () const
	Return the number of components in this component.
uint32_t	sizeData () const
	Return the size in bytes of the IFD data of this component when written to a binary image. This is a support function for write(). Components derived from TiffEntryBase implement this method corresponding to their implementation of writeData().
uint32_t	sizeImage () const
	Return the size in bytes of the image data of this component when written to a binary image. This is a support function for write(). TIFF components implement this method corresponding to their implementation of writeImage().

Protected Member Functions
Protected Creators
	TiffEntryBase (const TiffEntryBase &rhs)
	Copy constructor (used to implement clone()).
Protected Manipulators
virtual void	doEncode (TiffEncoder &encoder, const Exifdatum *datum)=0
	Implements encode().
void	setCount (uint32_t count)
	Set the number of components in this entry.
void	setIdx (int idx)
	Set the unique id of the entry in the image.
virtual uint32_t	doWrite (IoWrapper &ioWrapper, ByteOrder byteOrder, int32_t offset, uint32_t valueIdx, uint32_t dataIdx, uint32_t &imageIdx)
	Implements write(). Write the value of a standard TIFF entry to the ioWrapper, return the number of bytes written. Only the ioWrapper and byteOrder arguments are used.
Protected Accessors
virtual uint32_t	doCount () const
	Implements count().
virtual uint32_t	doWriteData (IoWrapper &ioWrapper, ByteOrder byteOrder, int32_t offset, uint32_t dataIdx, uint32_t &imageIdx) const
	Implements writeData(). Standard TIFF entries have no data: write nothing and return 0.
virtual uint32_t	doWriteImage (IoWrapper &ioWrapper, ByteOrder byteOrder) const
	Implements writeImage(). Standard TIFF entries have no image data: write nothing and return 0.
virtual uint32_t	doSize () const
	Implements size(). Return the size of a standard TIFF entry.
virtual uint32_t	doSizeData () const
	Implements sizeData(). Return 0.
virtual uint32_t	doSizeImage () const
	Implements sizeImage(). Return 0.
Protected Member Functions inherited from Exiv2::Internal::TiffComponent
virtual TiffComponent *	doAddPath (uint16_t tag, TiffPath &tiffPath, TiffComponent *const pRoot, TiffComponent::AutoPtr object)
	Implements addPath(). The default implementation does nothing.
virtual TiffComponent *	doAddChild (AutoPtr tiffComponent)
	Implements addChild(). The default implementation does nothing.
virtual TiffComponent *	doAddNext (AutoPtr tiffComponent)
	Implements addNext(). The default implementation does nothing.
virtual void	doAccept (TiffVisitor &visitor)=0
	Implements accept().
virtual TiffComponent *	doClone () const =0
	Internal virtual copy constructor, implements clone().

Static Protected Member Functions
static uint32_t	writeOffset (byte *buf, int32_t offset, TiffType tiffType, ByteOrder byteOrder)
	Helper function to write an offset to a preallocated binary buffer.

Friends
class	TiffReader
class	TiffEncoder
int	selectNikonLd (TiffBinaryArray *const, TiffComponent *const)

Additional Inherited Members
Public Types inherited from Exiv2::Internal::TiffComponent
typedef std::auto_ptr< TiffComponent >	AutoPtr
	TiffComponent auto_ptr type.
typedef std::vector< TiffComponent * >	Components
	Container type to hold all metadata.

Detailed Description

This abstract base class provides the common functionality of an IFD directory entry and defines an extended interface for derived concrete entries, which allows access to the attributes of the entry.

Member Function Documentation

encode()

void Exiv2::Internal::TiffEntryBase::encode	(	TiffEncoder &	encoder,
		const Exifdatum *	datum
	)

Encode a TIFF component from the metadatum provided and information from the encoder as needed.

Implemented as double-dispatch calls back to one of the specific encoding functions at the encoder.

References doEncode().

setValue()

void Exiv2::Internal::TiffEntryBase::setValue

(

Value::AutoPtr

value

)

Set tag value. Takes ownership of the pointer passed in.

Update type, count and the pointer to the value.

References Exiv2::Internal::toTiffType().

Referenced by updateValue().

updateValue()

void Exiv2::Internal::TiffEntryBase::updateValue	(	Value::AutoPtr	value,
		ByteOrder	byteOrder
	)

Update the value. Takes ownership of the pointer passed in.

Update binary value data and call setValue().

References setData(), and setValue().

---

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

• tiffcomposite_int.hpp
• tiffcomposite_int.cpp