Exiv2::LangAltValue Class Reference

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

#include <value.hpp>

Inheritance diagram for Exiv2::LangAltValue:

Inheritance graph
[legend]
Collaboration diagram for Exiv2::LangAltValue:

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::auto_ptr< LangAltValueAutoPtr
 Shortcut for a LangAltValue auto pointer.
typedef std::map< std::string,
std::string > 
ValueType
 Type used to store language alternative arrays.

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.
virtual int read (const byte *buf, long len, ByteOrder byteOrder=invalidByteOrder)
 Read the value from a character buffer.
virtual int read (const std::string &buf)=0
Accessors
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.
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.
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.
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.
virtual std::ostream & write (std::ostream &os) const
 Write all elements of the value to os, separated by commas.

Public Attributes

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

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.


Member Function Documentation

virtual int Exiv2::XmpValue::read const byte buf,
long  len,
ByteOrder  byteOrder = invalidByteOrder
 

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.

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.

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.

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.

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.

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:
Generated on Thu Dec 31 03:58:13 2009 for Exiv2 by  doxygen 1.3.9.1