Exiv2::ValueType< T > Class Template Reference

Template for a Value of a basic type. This is used for unsigned and signed short, long and rationals. More...

#include <value.hpp>

Inheritance diagram for Exiv2::ValueType< T >:

Public Types

typedef std::auto_ptr< ValueType< T > > AutoPtr
 Shortcut for a ValueType<T> auto pointer.
 
typedef std::vector< T > ValueList
 Container for values.
 
typedef std::vector< T >::iterator iterator
 Iterator type defined for convenience.
 
typedef std::vector< T >::const_iterator const_iterator
 Const iterator type defined for convenience.
 
- Public Types inherited from Exiv2::Value
typedef std::auto_ptr< ValueAutoPtr
 Shortcut for a Value auto pointer.
 

Public Member Functions

template<>
long toLong (long n) 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...
 
template<>
long toLong (long n) 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...
 
template<>
float toFloat (long n) 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...
 
template<>
float toFloat (long n) 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...
 
template<>
Rational toRational (long n) 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...
 
template<>
Rational toRational (long n) 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...
 
template<>
Rational toRational (long n) 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...
 
template<>
Rational toRational (long n) 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...
 
Creators
 ValueType ()
 Default Constructor.
 
 ValueType (TypeId typeId)
 Constructor.
 
 ValueType (const byte *buf, long len, ByteOrder byteOrder, TypeId typeId=getType< T >())
 Constructor.
 
 ValueType (const T &val, TypeId typeId=getType< T >())
 Constructor.
 
 ValueType (const ValueType< T > &rhs)
 Copy constructor.
 
virtual ~ValueType ()
 Virtual destructor.
 
Manipulators
ValueType< T > & operator= (const ValueType< T > &rhs)
 Assignment operator.
 
virtual int read (const byte *buf, long len, ByteOrder byteOrder)
 Read the value from a character buffer. More...
 
virtual int read (const std::string &buf)
 Set the data from a string of values of type T (e.g., "0 1 2 3" or "1/2 1/3 1/4" depending on what T is). Generally, the accepted input format is the same as that produced by the write() method.
 
virtual int setDataArea (const byte *buf, long len)
 Set the data area. This method copies (clones) the buffer pointed to by buf.
 
Accessors
AutoPtr clone () const
 
virtual long copy (byte *buf, ByteOrder byteOrder) const
 Write value to a data buffer. More...
 
virtual long count () const
 Return the number of components of the value.
 
virtual long size () const
 Return the size of the value in bytes.
 
virtual std::ostream & write (std::ostream &os) const
 Write the value to an output stream. You do not usually have to use this function; it is used for the implementation of the output operator for Value, operator<<(std::ostream &os, const Value &value).
 
virtual std::string toString (long n) const
 Return the n-th component of the value as a string. The behaviour of this method may be undefined if there is no n-th component.
 
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 long sizeDataArea () const
 Return the size of the data area.
 
virtual DataBuf dataArea () const
 Return a copy of the data area in a DataBuf. The caller owns this copy and DataBuf ensures that it will be deleted.
 
- 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.
 
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.
 
bool ok () const
 Check the ok status indicator. After a to<Type> conversion, this indicator shows whether the conversion was successful.
 

Public Attributes

ValueList value_
 The container for all values. In your application, if you know what subclass of Value you're dealing with (and possibly the T) then you can access this STL container through the usual standard library functions.
 

Additional Inherited Members

- 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::Value
Valueoperator= (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

template<typename T>
class Exiv2::ValueType< T >

Template for a Value of a basic type. This is used for unsigned and signed short, long and rationals.

Examples:
addmoddel.cpp.

Member Function Documentation

◆ copy()

template<typename T >
long Exiv2::ValueType< T >::copy ( byte buf,
ByteOrder  byteOrder 
) const
virtual

Write value to a data buffer.

The user must ensure that the buffer has enough memory. Otherwise the call results in undefined behaviour.

Parameters
bufData buffer to write to.
byteOrderApplicable byte order (little or big endian).
Returns
Number of bytes written.

Implements Exiv2::Value.

References Exiv2::toData(), and Exiv2::ValueType< T >::value_.

◆ read()

template<typename T >
int Exiv2::ValueType< T >::read ( const byte buf,
long  len,
ByteOrder  byteOrder 
)
virtual

Read the value from a character buffer.

Parameters
bufPointer to the data buffer to read from
lenNumber of bytes in the data buffer
byteOrderApplicable byte order (little or big endian).
Returns
0 if successful.

Implements Exiv2::Value.

References Exiv2::Value::typeId(), Exiv2::TypeInfo::typeSize(), and Exiv2::ValueType< T >::value_.

Referenced by Exiv2::ValueType< T >::ValueType().

◆ toFloat() [1/3]

template<typename T >
float Exiv2::ValueType< T >::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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toFloat() [2/3]

template<>
float Exiv2::ValueType< Rational >::toFloat ( long  n) const
inlinevirtual

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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toFloat() [3/3]

template<>
float Exiv2::ValueType< URational >::toFloat ( long  n) const
inlinevirtual

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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toLong() [1/3]

template<typename T >
long Exiv2::ValueType< T >::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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toLong() [2/3]

template<>
long Exiv2::ValueType< Rational >::toLong ( long  n) const
inlinevirtual

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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toLong() [3/3]

template<>
long Exiv2::ValueType< URational >::toLong ( long  n) const
inlinevirtual

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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toRational() [1/5]

template<typename T >
Rational Exiv2::ValueType< T >::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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toRational() [2/5]

template<>
Rational Exiv2::ValueType< Rational >::toRational ( long  n) const
inlinevirtual

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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toRational() [3/5]

template<>
Rational Exiv2::ValueType< URational >::toRational ( long  n) const
inlinevirtual

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.

References Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toRational() [4/5]

template<>
Rational Exiv2::ValueType< float >::toRational ( long  n) const
inlinevirtual

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.

References Exiv2::floatToRationalCast(), Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.

◆ toRational() [5/5]

template<>
Rational Exiv2::ValueType< double >::toRational ( long  n) const
inlinevirtual

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.

References Exiv2::floatToRationalCast(), Exiv2::Value::ok_, and Exiv2::ValueType< T >::value_.


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