Exiv2::AsciiValue Class Reference

Value for an Ascii string type. More...

#include <value.hpp>

Inheritance diagram for Exiv2::AsciiValue:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::auto_ptr< AsciiValueAutoPtr
 Shortcut for a AsciiValue auto pointer.

Public Member Functions

Creators
 AsciiValue ()
 Default constructor.
 AsciiValue (const std::string &buf)
 Constructor.
virtual ~AsciiValue ()
 Virtual destructor.
Manipulators
virtual int read (const std::string &buf)
 Set the value to that of the string buf. Overrides base class to append a terminating '\0' character if buf doesn't end with '\0'.
virtual int read (const std::string &buf)
 Read the value from buf. This default implementation uses buf as it is.
virtual int read (const byte *buf, long len, ByteOrder byteOrder=invalidByteOrder)
 Read the value from a character buffer.
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 std::ostream & write (std::ostream &os) const
 Write the value to an output stream. Any trailing '\0' characters of the ASCII value are stripped and not written to the output stream.

Detailed Description

Value for an Ascii string type.

This class is for null terminated single byte Ascii strings. This class also ensures that the string is null terminated.


Member Function Documentation

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

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:
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.


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