Exiv2
Loading...
Searching...
No Matches
Exiv2::Internal::TiffComponent Class Referenceabstract

Interface class for components of a TIFF directory hierarchy (Composite pattern). Both TIFF directories as well as entries implement this interface. A component can be uniquely identified by a tag, group tuple. This class is implemented as a NVI (Non-Virtual Interface) and it has an interface for visitors (Visitor pattern) to perform operations on all components. More...

#include <tiffcomposite_int.hpp>

Inheritance diagram for Exiv2::Internal::TiffComponent:

Public Types

using UniquePtr = std::unique_ptr<TiffComponent>
 TiffComponent auto_ptr type.
using Components = std::vector<UniquePtr>
 Container type to hold all metadata.

Public Member Functions

Creators
constexpr TiffComponent (uint16_t tag, IfdId group)
 Constructor.
virtual ~TiffComponent ()=default
 Virtual destructor.
 TiffComponent (const TiffComponent &)=default
TiffComponentoperator= (const TiffComponent &)=default
Manipulators
TiffComponentaddPath (uint16_t tag, TiffPath &tiffPath, TiffComponent *pRoot, UniquePtr object=nullptr)
 Add a TIFF entry tag to the component. Components on the path to the entry are added if they don't exist yet.
TiffComponentaddChild (UniquePtr tiffComponent)
 Add a child to the component. Default is to do nothing.
TiffComponentaddNext (UniquePtr tiffComponent)
 Add a "next" component to the component. Default is to do nothing.
void accept (TiffVisitor &visitor)
 Interface to accept visitors (Visitor pattern). Visitors can perform operations on all components of the composite.
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.
size_t write (IoWrapper &ioWrapper, ByteOrder byteOrder, size_t offset, size_t valueIdx, size_t dataIdx, size_t &imageIdx)
 Write a TiffComponent to a binary image.
Accessors
uint16_t tag () const
 Return the tag of this entry.
IfdId group () const
 Return the group id of this component.
bytestart () const
 Return a pointer to the start of the binary representation of the component.
UniquePtr 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.
size_t writeData (IoWrapper &ioWrapper, ByteOrder byteOrder, size_t offset, size_t dataIdx, size_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.
size_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.
size_t size () const
 Return the size in bytes of the IFD value of this component when written to a binary image.
size_t count () const
 Return the number of components in this component.
size_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().
size_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().
virtual int idx () const
 Return the unique id of the entry in the image.

Protected Member Functions

Protected Manipulators
virtual TiffComponentdoAddPath (uint16_t tag, TiffPath &tiffPath, TiffComponent *pRoot, TiffComponent::UniquePtr object)
 Implements addPath(). The default implementation does nothing.
virtual TiffComponentdoAddChild (UniquePtr tiffComponent)
 Implements addChild(). The default implementation does nothing.
virtual TiffComponentdoAddNext (UniquePtr tiffComponent)
 Implements addNext(). The default implementation does nothing.
virtual void doAccept (TiffVisitor &visitor)=0
 Implements accept().
virtual size_t doWrite (IoWrapper &ioWrapper, ByteOrder byteOrder, size_t offset, size_t valueIdx, size_t dataIdx, size_t &imageIdx)=0
 Implements write().

Protected Accessors

virtual TiffComponentdoClone () const =0
 Internal virtual copy constructor, implements clone().
virtual size_t doWriteData (IoWrapper &ioWrapper, ByteOrder byteOrder, size_t offset, size_t dataIdx, size_t &imageIdx) const =0
 Implements writeData().
virtual size_t doWriteImage (IoWrapper &ioWrapper, ByteOrder byteOrder) const =0
 Implements writeImage().
virtual size_t doSize () const =0
 Implements size().
virtual size_t doCount () const =0
 Implements count().
virtual size_t doSizeData () const =0
 Implements sizeData().
virtual size_t doSizeImage () const =0
 Implements sizeImage().

Detailed Description

Interface class for components of a TIFF directory hierarchy (Composite pattern). Both TIFF directories as well as entries implement this interface. A component can be uniquely identified by a tag, group tuple. This class is implemented as a NVI (Non-Virtual Interface) and it has an interface for visitors (Visitor pattern) to perform operations on all components.

Member Function Documentation

◆ accept()

void Exiv2::Internal::TiffComponent::accept ( TiffVisitor & visitor)

Interface to accept visitors (Visitor pattern). Visitors can perform operations on all components of the composite.

Parameters
visitorThe visitor.

References doAccept(), Exiv2::Internal::TiffVisitor::geTraverse, and Exiv2::Internal::TiffVisitor::go().

Referenced by Exiv2::Internal::TiffEncoder::add(), and Exiv2::Internal::nikonCrypt().

◆ addChild()

TiffComponent * Exiv2::Internal::TiffComponent::addChild ( TiffComponent::UniquePtr tiffComponent)

Add a child to the component. Default is to do nothing.

Parameters
tiffComponentAuto pointer to the component to add.
Returns
Return a pointer to the newly added child element or 0.

References doAddChild(), and TiffComponent().

Referenced by Exiv2::Internal::TiffBinaryArray::addElement(), Exiv2::Internal::TiffIfdMakernote::doAddChild(), Exiv2::Internal::TiffMnEntry::doAddChild(), Exiv2::Internal::TiffBinaryArray::doAddPath(), Exiv2::Internal::TiffDirectory::doAddPath(), and Exiv2::Internal::TiffSubIfd::doAddPath().

◆ addNext()

TiffComponent * Exiv2::Internal::TiffComponent::addNext ( TiffComponent::UniquePtr tiffComponent)

Add a "next" component to the component. Default is to do nothing.

Parameters
tiffComponentAuto pointer to the component to add.
Returns
Return a pointer to the newly added "next" element or 0.

References doAddNext(), and TiffComponent().

Referenced by Exiv2::Internal::TiffIfdMakernote::doAddNext(), Exiv2::Internal::TiffMnEntry::doAddNext(), and Exiv2::Internal::TiffDirectory::doAddPath().

◆ addPath()

TiffComponent * Exiv2::Internal::TiffComponent::addPath ( uint16_t tag,
TiffPath & tiffPath,
TiffComponent * pRoot,
TiffComponent::UniquePtr object = nullptr )

Add a TIFF entry tag to the component. Components on the path to the entry are added if they don't exist yet.

Parameters
tagThe tag of the new entry
tiffPathA path from the TIFF root element to a TIFF entry.
pRootPointer to the root component of the TIFF composite.
objectTIFF component to add. If 0, the correct entry will be created.
Returns
A pointer to the newly added TIFF entry.

References doAddPath(), tag(), and TiffComponent().

Referenced by Exiv2::Internal::TiffEncoder::add(), Exiv2::Internal::TiffDirectory::doAddPath(), and Exiv2::Internal::TiffIfdMakernote::doAddPath().

◆ doAccept()

◆ doAddChild()

TiffComponent * Exiv2::Internal::TiffComponent::doAddChild ( UniquePtr tiffComponent)
protectedvirtual

◆ doAddNext()

TiffComponent * Exiv2::Internal::TiffComponent::doAddNext ( UniquePtr tiffComponent)
protectedvirtual

Implements addNext(). The default implementation does nothing.

Reimplemented in Exiv2::Internal::TiffDirectory, Exiv2::Internal::TiffIfdMakernote, and Exiv2::Internal::TiffMnEntry.

References TiffComponent().

Referenced by addNext().

◆ doAddPath()

TiffComponent * Exiv2::Internal::TiffComponent::doAddPath ( uint16_t tag,
TiffPath & tiffPath,
TiffComponent * pRoot,
TiffComponent::UniquePtr object )
protectedvirtual

◆ doClone()

◆ doCount()

virtual size_t Exiv2::Internal::TiffComponent::doCount ( ) const
nodiscardprotectedpure virtual

◆ doSize()

◆ doSizeData()

virtual size_t Exiv2::Internal::TiffComponent::doSizeData ( ) const
nodiscardprotectedpure virtual

◆ doSizeImage()

virtual size_t Exiv2::Internal::TiffComponent::doSizeImage ( ) const
nodiscardprotectedpure virtual

◆ doWrite()

virtual size_t Exiv2::Internal::TiffComponent::doWrite ( IoWrapper & ioWrapper,
ByteOrder byteOrder,
size_t offset,
size_t valueIdx,
size_t dataIdx,
size_t & imageIdx )
protectedpure virtual

◆ doWriteData()

virtual size_t Exiv2::Internal::TiffComponent::doWriteData ( IoWrapper & ioWrapper,
ByteOrder byteOrder,
size_t offset,
size_t dataIdx,
size_t & imageIdx ) const
protectedpure virtual

◆ doWriteImage()

virtual size_t Exiv2::Internal::TiffComponent::doWriteImage ( IoWrapper & ioWrapper,
ByteOrder byteOrder ) const
protectedpure virtual

◆ idx()

int Exiv2::Internal::TiffComponent::idx ( ) const
nodiscardvirtual

Return the unique id of the entry in the image.

Reimplemented in Exiv2::Internal::TiffEntryBase.

Referenced by Exiv2::Internal::TiffDirectory::doWrite().

◆ write()

size_t Exiv2::Internal::TiffComponent::write ( IoWrapper & ioWrapper,
ByteOrder byteOrder,
size_t offset,
size_t valueIdx,
size_t dataIdx,
size_t & imageIdx )

Write a TiffComponent to a binary image.

Parameters
ioWrapperIO wrapper to which the TiffComponent is written.
byteOrderApplicable byte order (little or big endian).
offsetOffset from the start of the image (TIFF header) to the component.
valueIdxIndex of the component to be written relative to offset.
dataIdxIndex of the data area of the component relative to offset.
imageIdxIndex of the image data area relative to offset.
Returns
Number of bytes written to the IO wrapper including all nested components.
Exceptions
ErrorIf the component cannot be written.

References doWrite().


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