Abstract base class for a string based Value type. More...

#include <value.hpp>

Inheritance diagram for Exiv2::StringValueBase:

[legend]

Public Types
using	UniquePtr = std::unique_ptr< StringValueBase >
	Shortcut for a StringValueBase auto pointer.

Public Types inherited from Exiv2::Value
using	UniquePtr = std::unique_ptr< Value >
	Shortcut for a Value auto pointer.

Public Member Functions
Creators
	StringValueBase (TypeId typeId, const std::string &buf)
	Constructor for subclasses.

Manipulators
int	read (const std::string &buf) override
	Read the value from buf. This default implementation uses buf as it is.

int	read (const byte *buf, size_t len, ByteOrder byteOrder=invalidByteOrder) override
	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 ()=default
	Virtual destructor.

virtual int	setDataArea (const byte *buf, size_t 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).

UniquePtr	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 std::string	toString (size_t n) const
	Return the n-th component of the value as a string. The default implementation returns toString(). The behaviour of this method may be undefined if there is no n-th component.

virtual size_t	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
std::string	value_
	Stores the string value.

UniquePtr	clone () const

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

size_t	count () const override
	Return the number of components of the value.

size_t	size () const override
	Return the size of the value in bytes.

int64_t	toInt64 (size_t n=0) const override
	Convert the n-th component of the value to an int64_t. The behaviour of this method may be undefined if there is no n-th component. More...

uint32_t	toUint32 (size_t n=0) const override
	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...

float	toFloat (size_t n=0) const override
	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...

Rational	toRational (size_t n=0) const override
	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...

std::ostream &	write (std::ostream &os) const override
	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).

StringValueBase *	clone_ () const override=0
	Internal virtual copy constructor.

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

Protected Member Functions inherited from Exiv2::Value
	Value (const Value &)=default

Value &	operator= (const Value &)=default
	Assignment operator. Protected so that it can only be used by subclasses but not directly.

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

Detailed Description

Abstract base class for a string based Value type.

Uses a std::string to store the value and implements defaults for most operations.

Member Function Documentation

◆ copy()

size_t Exiv2::StringValueBase::copy	(	byte *	buf,
		ByteOrder	byteOrder = `invalidByteOrder`
	)		const

overridevirtual

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

buf	Data buffer to write to.
byteOrder	Byte order. Not used.

Returns: Number of characters written.

Implements Exiv2::Value.

Reimplemented in Exiv2::CommentValue.

◆ read()

int Exiv2::StringValueBase::read	(	const byte *	buf,
		size_t	len,
		ByteOrder	byteOrder = `invalidByteOrder`
	)

overridevirtual

Read the value from a character buffer.

Parameters

buf	Pointer to the data buffer to read from
len	Number of bytes in the data buffer
byteOrder	Applicable byte order (little or big endian).

Returns: 0 if successful.

Implements Exiv2::Value.

Reimplemented in Exiv2::CommentValue.

◆ toFloat()

float Exiv2::StringValueBase::toFloat ( size_t n = 0 ) const

overridevirtual

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.

◆ toInt64()

int64_t Exiv2::StringValueBase::toInt64 ( size_t n = 0 ) const

overridevirtual

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

Returns: The converted value.

Implements Exiv2::Value.

◆ toRational()

Rational Exiv2::StringValueBase::toRational ( size_t n = 0 ) const

overridevirtual

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.

◆ toUint32()

uint32_t Exiv2::StringValueBase::toUint32 ( size_t n = 0 ) const

overridevirtual

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.

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

◆ copy()

◆ read()

◆ toFloat()

◆ toInt64()

◆ toRational()

◆ toUint32()