Exiv2::IptcDataSets Class Reference

IPTC dataset reference, implemented as a static class. More...

#include <datasets.hpp>

Collaboration diagram for Exiv2::IptcDataSets:

Collaboration graph
[legend]
List of all members.

Static Public Member Functions

std::string dataSetName (uint16_t number, uint16_t recordId)
 Return the name of the dataset.
const char * dataSetTitle (uint16_t number, uint16_t recordId)
 Return the title (label) of the dataset.
const char * dataSetDesc (uint16_t number, uint16_t recordId)
 Return the description of the dataset.
const char * dataSetPsName (uint16_t number, uint16_t recordId)
 Return the photohsop name of a given dataset.
bool dataSetRepeatable (uint16_t number, uint16_t recordId)
 Check if a given dataset is repeatable.
uint16_t dataSet (const std::string &dataSetName, uint16_t recordId)
 Return the dataSet number for dataset name and record id.
TypeId dataSetType (uint16_t number, uint16_t recordId)
 Return the type for dataSet number and Record id.
std::string recordName (uint16_t recordId)
 Return the name of the Record.
const char * recordDesc (uint16_t recordId)
 Return the description of a record.
uint16_t recordId (const std::string &recordName)
 Return the Id number of a record.
const DataSetenvelopeRecordList ()
 Return read-only list of built-in Envelope Record datasets.
const DataSetapplication2RecordList ()
 Return read-only list of built-in Application2 Record datasets.
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_t invalidRecord = 0
const uint16_t envelope = 1
const uint16_t application2 = 2
Dataset identifiers
const uint16_t ModelVersion = 0
const uint16_t Destination = 5
const uint16_t FileFormat = 20
const uint16_t FileVersion = 22
const uint16_t ServiceId = 30
const uint16_t EnvelopeNumber = 40
const uint16_t ProductId = 50
const uint16_t EnvelopePriority = 60
const uint16_t DateSent = 70
const uint16_t TimeSent = 80
const uint16_t CharacterSet = 90
const uint16_t UNO = 100
const uint16_t ARMId = 120
const uint16_t ARMVersion = 122
const uint16_t RecordVersion = 0
const uint16_t ObjectType = 3
const uint16_t ObjectAttribute = 4
const uint16_t ObjectName = 5
const uint16_t EditStatus = 7
const uint16_t EditorialUpdate = 8
const uint16_t Urgency = 10
const uint16_t Subject = 12
const uint16_t Category = 15
const uint16_t SuppCategory = 20
const uint16_t FixtureId = 22
const uint16_t Keywords = 25
const uint16_t LocationCode = 26
const uint16_t LocationName = 27
const uint16_t ReleaseDate = 30
const uint16_t ReleaseTime = 35
const uint16_t ExpirationDate = 37
const uint16_t ExpirationTime = 38
const uint16_t SpecialInstructions = 40
const uint16_t ActionAdvised = 42
const uint16_t ReferenceService = 45
const uint16_t ReferenceDate = 47
const uint16_t ReferenceNumber = 50
const uint16_t DateCreated = 55
const uint16_t TimeCreated = 60
const uint16_t DigitizationDate = 62
const uint16_t DigitizationTime = 63
const uint16_t Program = 65
const uint16_t ProgramVersion = 70
const uint16_t ObjectCycle = 75
const uint16_t Byline = 80
const uint16_t BylineTitle = 85
const uint16_t City = 90
const uint16_t SubLocation = 92
const uint16_t ProvinceState = 95
const uint16_t CountryCode = 100
const uint16_t CountryName = 101
const uint16_t TransmissionReference = 103
const uint16_t Headline = 105
const uint16_t Credit = 110
const uint16_t Source = 115
const uint16_t Copyright = 116
const uint16_t Contact = 118
const uint16_t Caption = 120
const uint16_t Writer = 122
const uint16_t RasterizedCaption = 125
const uint16_t ImageType = 130
const uint16_t ImageOrientation = 131
const uint16_t Language = 135
const uint16_t AudioType = 150
const uint16_t AudioRate = 151
const uint16_t AudioResolution = 152
const uint16_t AudioDuration = 153
const uint16_t AudioOutcue = 154
const uint16_t PreviewFormat = 200
const uint16_t PreviewVersion = 201
const uint16_t Preview = 202

Detailed Description

IPTC dataset reference, implemented as a static class.


Member Function Documentation

uint16_t Exiv2::IptcDataSets::dataSet const std::string &  dataSetName,
uint16_t  recordId
[static]
 

Return the dataSet number for dataset name and record id.

Parameters:
dataSetName dataSet name
recordId recordId
Returns:
dataSet number
Exceptions:
Error if the dataSetName or recordId are invalid

const char* Exiv2::IptcDataSets::dataSetDesc uint16_t  number,
uint16_t  recordId
[static]
 

Return the description of the dataset.

Parameters:
number The dataset number
recordId The IPTC record Id
Returns:
The description of the dataset

std::string Exiv2::IptcDataSets::dataSetName uint16_t  number,
uint16_t  recordId
[static]
 

Return the name of the dataset.

Parameters:
number The dataset number
recordId The IPTC record Id
Returns:
The name of the dataset or a string containing the hexadecimal value of the dataset in the form "0x01ff", if this is an unknown dataset.

const char* Exiv2::IptcDataSets::dataSetPsName uint16_t  number,
uint16_t  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.

bool Exiv2::IptcDataSets::dataSetRepeatable uint16_t  number,
uint16_t  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

const char* Exiv2::IptcDataSets::dataSetTitle uint16_t  number,
uint16_t  recordId
[static]
 

Return the title (label) of the dataset.

Parameters:
number The dataset number
recordId The IPTC record Id
Returns:
The title (label) of the dataset

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

Return the description of a record.

Parameters:
recordId Record Id number
Returns:
the description of the Record

uint16_t 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 if the record is not known;

std::string Exiv2::IptcDataSets::recordName uint16_t  recordId  )  [static]
 

Return the name of the Record.

Parameters:
recordId The record id
Returns:
The name of the record or a string containing the hexadecimal value of the record in the form "0x01ff", if this is an unknown record.


The documentation for this class was generated from the following file:
Generated on Thu Dec 31 03:57:59 2009 for Exiv2 by  doxygen 1.3.9.1