Exiv2::IptcDataSets Class Reference

Container for Iptc dataset information. Implemented as a static class. More...

#include <datasets.hpp>

Collaboration diagram for Exiv2::IptcDataSets:

[legend]List of all members.

Static Public Member Functions
const char *	familyName ()
	Return an identifier for Iptc datasets.
const char *	dataSetName (uint16 number, uint16 recordId)
	Return the name of the dataset.
const char *	dataSetDesc (uint16 number, uint16 recordId)
	Return the description of the dataset.
const char *	dataSetPsName (uint16 number, uint16 recordId)
	Return the photohsop name of a given dataset.
bool	dataSetRepeatable (uint16 number, uint16 recordId)
	Check if a given dataset is repeatable.
uint16	dataSet (const std::string &dataSetName, uint16 recordId)
	Return the dataSet number for dataset name and record id.
TypeId	dataSetType (uint16 number, uint16 recordId)
	Return the type for dataSet number and Record id.
const char *	recordName (uint16 recordId)
	Return the name of the Record.
const char *	recordDesc (uint16 recordId)
	Return the description of a record.
uint16	recordId (const std::string &recordName)
	Return the Id number of a record.
std::string	makeKey (uint16 number, uint16 recordId)
	Return the key for the dataSet number and record id. The key is of the form 'Iptc.recordName.dataSetName'.
std::string	makeKey (const DataSet &dataSet)
	Return the key for the dataSet. The key is of the form 'Iptc.recordName.dataSetName'.
std::pair< uint16, uint16 >	decomposeKey (const std::string &key)
	Return dataSet and record id pair for the key.
void	dataSetList (std::ostream &os)
	Print a list of all dataSets to output stream.
Static Public Attributes
Record identifiers
Record identifiers to logically group dataSets. There are other possible record types, but they are not standardized by the Iptc IIM4 standard (and not commonly used in images).
const uint16	invalidRecord = 0
const uint16	envelope = 1
const uint16	application2 = 2
Dataset identifiers
const uint16	ModelVersion = 0
const uint16	Destination = 5
const uint16	FileFormat = 20
const uint16	FileVersion = 22
const uint16	ServiceId = 30
const uint16	EnvelopeNumber = 40
const uint16	ProductId = 50
const uint16	EnvelopePriority = 60
const uint16	DateSent = 70
const uint16	TimeSent = 80
const uint16	CharacterSet = 90
const uint16	UNO = 100
const uint16	ARMId = 120
const uint16	ARMVersion = 122
const uint16	RecordVersion = 0
const uint16	ObjectType = 3
const uint16	ObjectAttribute = 4
const uint16	ObjectName = 5
const uint16	EditStatus = 7
const uint16	EditorialUpdate = 8
const uint16	Urgency = 10
const uint16	Subject = 12
const uint16	Category = 15
const uint16	SuppCategory = 20
const uint16	FixtureId = 22
const uint16	Keywords = 25
const uint16	LocationCode = 26
const uint16	LocationName = 27
const uint16	ReleaseDate = 30
const uint16	ReleaseTime = 35
const uint16	ExpirationDate = 37
const uint16	ExpirationTime = 38
const uint16	SpecialInstructions = 40
const uint16	ActionAdvised = 42
const uint16	ReferenceService = 45
const uint16	ReferenceDate = 47
const uint16	ReferenceNumber = 50
const uint16	DateCreated = 55
const uint16	TimeCreated = 60
const uint16	DigitizationDate = 62
const uint16	DigitizationTime = 63
const uint16	Program = 65
const uint16	ProgramVersion = 70
const uint16	ObjectCycle = 75
const uint16	Byline = 80
const uint16	BylineTitle = 85
const uint16	City = 90
const uint16	SubLocation = 92
const uint16	ProvinceState = 95
const uint16	CountryCode = 100
const uint16	CountryName = 101
const uint16	TransmissionReference = 103
const uint16	Headline = 105
const uint16	Credit = 110
const uint16	Source = 115
const uint16	Copyright = 116
const uint16	Contact = 118
const uint16	Caption = 120
const uint16	Writer = 122
const uint16	RasterizedCaption = 125
const uint16	ImageType = 130
const uint16	ImageOrientation = 131
const uint16	Language = 135
const uint16	AudioType = 150
const uint16	AudioRate = 151
const uint16	AudioResolution = 152
const uint16	AudioDuration = 153
const uint16	AudioOutcue = 154
const uint16	PreviewFormat = 200
const uint16	PreviewVersion = 201
const uint16	Preview = 202

---

Detailed Description

Container for Iptc dataset information. Implemented as a static class.

---

Member Function Documentation

const char * Exiv2::IptcDataSets::dataSetDesc (  uint16  number, uint16  recordId )  [static]

Return the description of the dataset. Parameters: number  The dataset number recordId  The Iptc record Id Returns: The description of the dataset Exceptions: Error  ("No dataset for recordId") if there is no dataset info for the given record id in the lookup tables.

const char * Exiv2::IptcDataSets::dataSetName (  uint16  number, uint16  recordId )  [static]

Return the name of the dataset. Parameters: number  The dataset number recordId  The Iptc record Id Returns: The name of the dataset Exceptions: Error  ("No dataset for recordId") if there is no dataset info for the given record id in the lookup tables.

const char * Exiv2::IptcDataSets::dataSetPsName (  uint16  number, uint16  recordId )  [static]

Return the photohsop name of a given dataset. Parameters: number  The dataset number recordId  The Iptc record Id Returns: The name used by photoshop for a dataset or an empty string if photoshop does not use the dataset. Exceptions: Error  ("No dataset for recordId") if there is no dataset info for the given record id in the lookup tables.

bool Exiv2::IptcDataSets::dataSetRepeatable (  uint16  number, uint16  recordId )  [static]

Check if a given dataset is repeatable. Parameters: number  The dataset number recordId  The Iptc record Id Returns: true if the given dataset is repeatable otherwise false Exceptions: Error  ("No dataset for recordId") if there is no dataset info for the given record id in the lookup tables.

std::pair< uint16, uint16 > Exiv2::IptcDataSets::decomposeKey (  const std::string &  key  )  [static]

Return dataSet and record id pair for the key. Returns: A pair consisting of the dataSet number and record id. Exceptions: Error  ("Invalid key") if the key cannot be parsed into record name and dataSet name parts.

const char * Exiv2::IptcDataSets::recordDesc (  uint16  recordId  )  [static]

Return the description of a record. Parameters: recordId  Record Id number Returns: the description of the Record Exceptions: Error("Unknown  record");

uint16 Exiv2::IptcDataSets::recordId (  const std::string &  recordName  )  [static]

Return the Id number of a record. Parameters: recordName  Name of a record type Returns: the Id number of a Record Exceptions: Error("Unknown  record");

---

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

• datasets.hpp
• datasets.cpp

---