Exiv2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Classes | Public Types
Exiv2::TimeValue Class Reference

Value for simple ISO 8601 times. More...

#include <value.hpp>

+ Inheritance diagram for Exiv2::TimeValue:
+ Collaboration diagram for Exiv2::TimeValue:

List of all members.

Classes

struct  Time
 Simple Time helper structure. More...

Public Types

typedef std::auto_ptr< TimeValueAutoPtr
 Shortcut for a TimeValue auto pointer.

Public Member Functions

Creators
 TimeValue ()
 Default constructor.
 TimeValue (int hour, int minute, int second=0, int tzHour=0, int tzMinute=0)
 Constructor.
virtual ~TimeValue ()
 Virtual destructor.

Manipulators

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)
 Set the value to that of the string buf.
void setTime (const Time &src)
 Set the time.

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 copy (byte *buf, ByteOrder byteOrder=invalidByteOrder) const
 Write value to a character data buffer.
virtual const TimegetTime () const
 Return time struct containing time information.
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 long toLong (long n=0) const
 Returns number of seconds in the day in UTC.
virtual float toFloat (long n=0) const
 Returns number of seconds in the day in UTC converted to float.
virtual Rational toRational (long n=0) const
 Returns number of seconds in the day in UTC converted to Rational.

Detailed Description

Value for simple ISO 8601 times.

This class is limited to handling simple time strings in the ISO 8601 format HHMMSS±HHMM where HHMMSS refers to local hour, minute and seconds and ±HHMM refers to hours and minutes ahead or behind Universal Coordinated Time.


Member Function Documentation

long Exiv2::TimeValue::copy ( byte buf,
ByteOrder  byteOrder = invalidByteOrder 
) const [virtual]

Write value to a character data buffer.

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

Note:
The byte order is required by the interface but not used by this method, so just use the default.
Parameters:
bufData buffer to write to.
byteOrderByte order. Not used.
Returns:
Number of characters written.

Implements Exiv2::Value.

References Exiv2::TimeValue::Time::hour, Exiv2::TimeValue::Time::minute, Exiv2::TimeValue::Time::second, Exiv2::TimeValue::Time::tzHour, and Exiv2::TimeValue::Time::tzMinute.

int Exiv2::TimeValue::read ( const byte buf,
long  len,
ByteOrder  byteOrder = invalidByteOrder 
) [virtual]

Read the value from a character buffer.

Note:
The byte order is required by the interface but not used by this method, so just use the default.
Parameters:
bufPointer to the data buffer to read from
lenNumber of bytes in the data buffer
byteOrderByte order. Not needed.
Returns:
0 if successful
1 in case of an unsupported time format

Implements Exiv2::Value.

References EXV_WARNING.

int Exiv2::TimeValue::read ( const std::string &  buf) [virtual]

Set the value to that of the string buf.

Parameters:
bufString containing the time.
Returns:
0 if successful
1 in case of an unsupported time format

Implements Exiv2::Value.

References EXV_WARNING.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines