Concrete keys for Exif metadata and access to Exif tag reference data. More...

#include <tags.hpp>

Inheritance diagram for Exiv2::ExifKey:

Public Types
typedef std::auto_ptr< ExifKey >	AutoPtr
	Shortcut for an ExifKey auto pointer.

Public Types inherited from Exiv2::Key
typedef std::auto_ptr< Key >	AutoPtr
	Shortcut for a Key auto pointer.

Public Member Functions
Creators
	ExifKey (const std::string &key)
	Constructor to create an Exif key from a key string. More...

	ExifKey (uint16_t tag, const std::string &groupName)
	Constructor to create an Exif key from the tag number and group name. More...

	ExifKey (const TagInfo &ti)
	Constructor to create an Exif key from a TagInfo instance. More...

	ExifKey (const ExifKey &rhs)
	Copy constructor.

virtual	~ExifKey ()
	Destructor.

Manipulators
ExifKey &	operator= (const ExifKey &rhs)
	Assignment operator.

void	setIdx (int idx)
	Set the index.

Public Member Functions inherited from Exiv2::Key
virtual	~Key ()
	Destructor.

AutoPtr	clone () const
	Return an auto-pointer to a copy of itself (deep copy). The caller owns this copy and the auto-pointer ensures that it will be deleted.

std::ostream &	write (std::ostream &os) const
	Write the key to an output stream. You do not usually have to use this function; it is used for the implementation of the output operator for Key, operator<<(std::ostream &os, const Key &key).

Accessors
virtual std::string	key () const
	Return the key of the metadatum as a string. The key is of the form 'familyName.groupName.tagName'. Note however that the key is not necessarily unique, e.g., an ExifData may contain multiple metadata with the same key.

virtual const char *	familyName () const
	Return an identifier for the type of metadata (the first part of the key)

virtual std::string	groupName () const
	Return the name of the group (the second part of the key)

int	ifdId () const
	Return the IFD id as an integer. (Do not use, this is meant for library internal use.)

virtual std::string	tagName () const
	Return the name of the tag (which is also the third part of the key)

virtual uint16_t	tag () const
	Return the tag number.

virtual std::string	tagLabel () const
	Return a label for the tag.

std::string	tagDesc () const
	Return the tag description.

TypeId	defaultTypeId () const
	Return the default type id for this tag.

AutoPtr	clone () const

int	idx () const
	Return the index (unique id of this key within the original Exif data, 0 if not set)

Additional Inherited Members
Protected Member Functions inherited from Exiv2::Key
Key &	operator= (const Key &rhs)
	Assignment operator. Protected so that it can only be used by subclasses but not directly.

Detailed Description

Concrete keys for Exif metadata and access to Exif tag reference data.

Constructor & Destructor Documentation

Exiv2::ExifKey::ExifKey ( const std::string & key )

explicit

Constructor to create an Exif key from a key string.

Parameters

key	The key string.

Exceptions

Error if the first part of the key is not 'Exif' or the remainin parts of the key cannot be parsed and converted to a group name and tag name.

Constructor to create an Exif key from the tag number and group name.

Parameters

tag	The tag value
groupName	The name of the group, i.e., the second part of the Exif key.

Exceptions

Error if the key cannot be constructed from the tag number and group name.

Exiv2::ExifKey::ExifKey ( const TagInfo & ti )

explicit

Constructor to create an Exif key from a TagInfo instance.

Parameters

ti	The TagInfo instance

Exceptions

Error if the key cannot be constructed from the tag number and group name.

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