FreeImagePlus FreeImage 3.18.0
fipMetadataFind Class Reference

Metadata iterator. More...

#include <FreeImagePlus.h>

Inheritance diagram for fipMetadataFind:
fipObject

Public Member Functions

BOOL isValid () const
 Returns TRUE if the search handle is allocated, FALSE otherwise.
 
 fipMetadataFind ()
 Constructor.
 
virtual ~fipMetadataFind ()
 Destructor.
 
BOOL findFirstMetadata (FREE_IMAGE_MDMODEL model, fipImage &image, fipTag &tag)
 Provides information about the first instance of a tag that matches the metadata model specified in the model argument.
 
BOOL findNextMetadata (fipTag &tag)
 Find the next tag, if any, that matches the metadata model argument in a previous call to findFirstMetadata.
 
- Public Member Functions inherited from fipObject
virtual ~fipObject ()
 Destructor.
 

Protected Attributes

FIMETADATA * _mdhandle
 Pointer to a search handle.
 

Detailed Description

Metadata iterator.

Usage :

fipImage image;
// ...
fipTag tag;
fipMetadataFind finder;
if( finder.findFirstMetadata(FIMD_EXIF_MAIN, image, tag) ) {
  do {
    // process the tag
        cout << tag.getKey() << "\n";

  } while( finder.findNextMetadata(tag) );
}
// the class can be called again with another metadata model
if( finder.findFirstMetadata(FIMD_EXIF_EXIF, image, tag) ) {
  do {
    // process the tag
        cout << tag.getKey() << "\n";

  } while( finder.findNextMetadata(tag) );
}

Constructor & Destructor Documentation

◆ fipMetadataFind()

fipMetadataFind::fipMetadataFind ( )

Constructor.

◆ ~fipMetadataFind()

virtual fipMetadataFind::~fipMetadataFind ( )
virtual

Destructor.

See also
FreeImage_FindCloseMetadata

Member Function Documentation

◆ findFirstMetadata()

BOOL fipMetadataFind::findFirstMetadata ( FREE_IMAGE_MDMODEL model,
fipImage & image,
fipTag & tag )

Provides information about the first instance of a tag that matches the metadata model specified in the model argument.

Parameters
modelMetadata model
imageInput image
tagReturned tag
Returns
Returns TRUE if successful, returns FALSE otherwise
See also
FreeImage_FindFirstMetadata

◆ findNextMetadata()

BOOL fipMetadataFind::findNextMetadata ( fipTag & tag)

Find the next tag, if any, that matches the metadata model argument in a previous call to findFirstMetadata.

Parameters
tagReturned tag
Returns
Returns TRUE if successful, returns FALSE otherwise, indicating that no more matching tags could be found
See also
FreeImage_FindNextMetadata

◆ isValid()

BOOL fipMetadataFind::isValid ( ) const
virtual

Returns TRUE if the search handle is allocated, FALSE otherwise.

Implements fipObject.

Member Data Documentation

◆ _mdhandle

FIMETADATA* fipMetadataFind::_mdhandle
protected

Pointer to a search handle.


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