OpenRaw::RawFile Class Reference

Inheritance diagram for OpenRaw::RawFile:

List of all members.

Public Types
typedef ::or_rawfile_type	Type
Public Member Functions
virtual	~RawFile ()
Type	type () const
const std::vector< uint32_t > &	listThumbnailSizes (void)
::or_error	getThumbnail (uint32_t size, Thumbnail &thumbnail)
Static Public Member Functions
static RawFile *	newRawFile (const char *_filename, Type _typeHint=OR_RAWFILE_TYPE_UNKNOWN)
Protected Member Functions
	RawFile (const char *_filename, Type _type)
virtual ::or_error	_enumThumbnailSizes (std::vector< uint32_t > &list)=0
virtual ::or_error	_getThumbnail (uint32_t size, Thumbnail &thumbnail)=0
Classes
class	Private

---

Detailed Description

Definition at line 37 of file rawfile.h.

---

Constructor & Destructor Documentation

OpenRaw::RawFile::~RawFile

(

)

[virtual]

Destructor

Definition at line 152 of file rawfile.cpp.

OpenRaw::RawFile::RawFile	(	const char *	_filename,
		Type	_type
	)			[protected]

Construct a raw file

Parameters:

	_filename	the RAW file name
	_type	the type

Definition at line 145 of file rawfile.cpp.

---

Member Function Documentation

RawFile * OpenRaw::RawFile::newRawFile	(	const char *	_filename,
		Type	_typeHint = OR_RAWFILE_TYPE_UNKNOWN
	)			[static]

factory method to create the proper RawFile instance.

Parameters:

	_filename	the name of the file to load
	_typeHint	a hint on the type. Use UNKNOWN_TYPE if you want to let the library detect it for you.

Definition at line 96 of file rawfile.cpp.

References OpenRaw::init(), and type().

RawFile::Type OpenRaw::RawFile::type

(

)

const

Accessor for the type

Definition at line 158 of file rawfile.cpp.

References OpenRaw::RawFile::Private::m_type.

Referenced by OpenRaw::Internals::IFDFile::_locateThumbnail(), and newRawFile().

const std::vector< uint32_t > & OpenRaw::RawFile::listThumbnailSizes

(

void

)

list the available thumbnail sizes

Definition at line 163 of file rawfile.cpp.

References _enumThumbnailSizes(), and OpenRaw::RawFile::Private::m_sizes.

Referenced by getThumbnail().

or_error OpenRaw::RawFile::getThumbnail	(	uint32_t	size,
		Thumbnail &	thumbnail
	)

Get the thumbnail from the raw file

Parameters:

	thumbnail	the thumbnail to extract into
	size	the square size in px

Returns:

the error code

Definition at line 176 of file rawfile.cpp.

References _getThumbnail(), and listThumbnailSizes().

virtual ::or_error OpenRaw::RawFile::_enumThumbnailSizes

(

std::vector< uint32_t > &

list

)

[protected, pure virtual]

enumerate the thumbnail sizes.

Parameters:

list

the list to enumerate into

Returns:

OR_ERROR_NONE if success

Implemented in OpenRaw::Internals::CRWFile, and OpenRaw::Internals::IFDFile.

Referenced by listThumbnailSizes().

virtual ::or_error OpenRaw::RawFile::_getThumbnail	(	uint32_t	size,
		Thumbnail &	thumbnail
	)			[protected, pure virtual]

get the thumbnail of exact size.

Parameters:

size

the size in pixel of the square

Return values:

thumbnail

the thumbnail to load

Returns:

OR_ERROR_NONE if success listThumbnailSizes() to understand how to fetch the sizes available

Implemented in OpenRaw::Internals::CRWFile.

Referenced by getThumbnail().

---

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

• include/libopenraw++/rawfile.h
• lib/rawfile.cpp

---