Value type for XMP language alternative properties. More...

#include <value.hpp>

Inheritance diagram for Exiv2::LangAltValue:

Public Types
typedef std::auto_ptr< LangAltValue >	AutoPtr
	Shortcut for a LangAltValue auto pointer.

Public Types inherited from Exiv2::XmpValue
enum	XmpArrayType { xaNone, xaAlt, xaBag, xaSeq }
	XMP array types.

enum	XmpStruct { xsNone, xsStruct }
	XMP structure indicator.

typedef std::auto_ptr< XmpValue >	AutoPtr
	Shortcut for a XmpValue auto pointer.

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

Public Member Functions
Creators
	LangAltValue ()
	Constructor.

	LangAltValue (const std::string &buf)
	Constructor, reads the value from a string.

Manipulators
virtual int	read (const std::string &buf)
	Read a simple property value from buf and append it to the value. More...

virtual int	read (const byte *buf, long len, ByteOrder byteOrder=invalidByteOrder)
	Read the value from a character buffer. More...

virtual int	read (const std::string &buf)=0

Public Member Functions inherited from Exiv2::XmpValue
	XmpValue (TypeId typeId)

XmpArrayType	xmpArrayType () const
	Return XMP array type, indicates if an XMP value is an array.

XmpStruct	xmpStruct () const
	Return XMP struct, indicates if an XMP value is a structure.

virtual long	size () const
	Return the size of the value in bytes.

virtual long	copy (byte *buf, ByteOrder byteOrder=invalidByteOrder) const
	Write value to a character data buffer. More...

void	setXmpArrayType (XmpArrayType xmpArrayType)
	Set the XMP array type to indicate that an XMP value is an array.

void	setXmpStruct (XmpStruct xmpStruct=xsStruct)
	Set the XMP struct type to indicate that an XMP value is a structure.

virtual int	read (const byte *buf, long len, ByteOrder byteOrder=invalidByteOrder)
	Read the value from a character buffer. More...

Public Member Functions inherited from Exiv2::Value
	Value (TypeId typeId)
	Constructor, taking a type id to initialize the base class with.

virtual	~Value ()
	Virtual destructor.

virtual int	setDataArea (const byte *buf, long len)
	Set the data area, if the value has one by copying (cloning) the buffer pointed to by buf. More...

TypeId	typeId () const
	Return the type identifier (Exif data format type).

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::string	toString () const
	Return the value as a string. Implemented in terms of write(std::ostream& os) const of the concrete class.

virtual long	sizeDataArea () const
	Return the size of the data area, 0 if there is none.

virtual DataBuf	dataArea () const
	Return a copy of the data area if the value has one. The caller owns this copy and DataBuf ensures that it will be deleted. More...

bool	ok () const
	Check the ok status indicator. After a to<Type> conversion, this indicator shows whether the conversion was successful.

Accessors
typedef std::map< std::string, std::string, LangAltValueComparator >	ValueType
	Type used to store language alternative arrays.

ValueType	value_
	Map to store the language alternative values. The language qualifier is used as the key for the map entries.

AutoPtr	clone () const

virtual long	count () const
	Return the number of components of the value.

virtual std::string	toString (long n) const
	Return the text value associated with the default language qualifier `x-default`. The parameter n is not used, but it is suggested that only 0 is passed in. Returns an empty string and sets the ok-flag to `false` if there is no default value.

std::string	toString (const std::string &qualifier) const
	Return the text value associated with the language qualifier qualifier. Returns an empty string and sets the ok-flag to `false` if there is no entry for the language qualifier.

virtual long	toLong (long n=0) const
	Convert the n-th component of the value to a long. The behaviour of this method may be undefined if there is no n-th component. More...

virtual float	toFloat (long n=0) const
	Convert the n-th component of the value to a float. The behaviour of this method may be undefined if there is no n-th component. More...

virtual Rational	toRational (long n=0) const
	Convert the n-th component of the value to a Rational. The behaviour of this method may be undefined if there is no n-th component. More...

virtual std::ostream &	write (std::ostream &os) const
	Write all elements of the value to os, separated by commas. More...

Additional Inherited Members
Static Public Member Functions inherited from Exiv2::XmpValue
static XmpArrayType	xmpArrayType (TypeId typeId)
	Return XMP array type for an array Value TypeId, xaNone if typeId is not an XMP array value type.

Static Public Member Functions inherited from Exiv2::Value
static AutoPtr	create (TypeId typeId)
	A (simple) factory to create a Value type. More...

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

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

Protected Attributes inherited from Exiv2::Value
bool	ok_
	Indicates the status of the previous to<Type> conversion.

Detailed Description

Value type for XMP language alternative properties.

A language alternative is an array consisting of simple text values, each of which has a language qualifier.

Examples: exiv2json.cpp.

Member Function Documentation

◆ read() [1/2]

virtual int Exiv2::XmpValue::read

Read the value from a character buffer.

Uses read(const std::string& buf)

Note: The byte order is required by the interface but not used by this method, so just use the default.

Parameters

buf	Pointer to the data buffer to read from
len	Number of bytes in the data buffer
byteOrder	Byte order. Not needed.

Returns: 0 if successful.

◆ read() [2/2]

virtual int Exiv2::LangAltValue::read ( const std::string & buf )

virtual

Read a simple property value from buf and append it to the value.

Appends buf to the value after the last existing array element. Subsequent calls will therefore populate multiple array elements in the order they are read.

The format of buf is:
[lang=["]language code["] ]text
The XMP default language code x-default is used if buf doesn't start with the keyword lang.

Returns: 0 if successful.

Implements Exiv2::XmpValue.

◆ toFloat()

virtual float Exiv2::LangAltValue::toFloat ( long n = 0 ) const

virtual

Convert the n-th component of the value to a float. The behaviour of this method may be undefined if there is no n-th component.

Returns: The converted value.

Implements Exiv2::Value.

◆ toLong()

virtual long Exiv2::LangAltValue::toLong ( long n = 0 ) const

virtual

Convert the n-th component of the value to a long. The behaviour of this method may be undefined if there is no n-th component.

Returns: The converted value.

Implements Exiv2::Value.

◆ toRational()

virtual Rational Exiv2::LangAltValue::toRational ( long n = 0 ) const

virtual

Convert the n-th component of the value to a Rational. The behaviour of this method may be undefined if there is no n-th component.

Returns: The converted value.

Implements Exiv2::Value.

◆ write()

virtual std::ostream& Exiv2::LangAltValue::write ( std::ostream & os ) const

virtual

Write all elements of the value to os, separated by commas.

Note: The output of this method cannot directly be used as the parameter for read().

Implements Exiv2::Value.

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

value.hpp

Public Types

Public Member Functions

Accessors

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ read() [1/2]

◆ read() [2/2]

◆ toFloat()

◆ toLong()

◆ toRational()

◆ write()