lti::ioBMP::parameters Class Reference

Parameter class of the ioBMP class. More...

#include <ltiBMPFunctor.h>

Inheritance diagram for lti::ioBMP::parameters:

[legend]

Collaboration diagram for lti::ioBMP::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
virtual const char *	getTypeName () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
bool	compression
int	bitsPerPixel
int	quantColors

---

Detailed Description

Parameter class of the ioBMP class.

---

Constructor & Destructor Documentation

lti::ioBMP::parameters::parameters

(

)

default constructor

Reimplemented from lti::ioFunctor::parameters.

lti::ioBMP::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Reimplemented from lti::ioFunctor::parameters.

References copy().

---

Member Function Documentation

virtual functor::parameters* lti::ioBMP::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters.

Reimplemented from lti::ioFunctor::parameters.

parameters& lti::ioBMP::parameters::copy

(

const parameters &

other

)

copy member

Reimplemented from lti::ioFunctor::parameters.

Referenced by parameters().

virtual const char* lti::ioBMP::parameters::getTypeName

(

)

const [virtual]

returns name of this class

Reimplemented from lti::ioFunctor::parameters.

virtual bool lti::ioBMP::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::ioFunctor::parameters.

virtual bool lti::ioBMP::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::ioFunctor::parameters.

---

Member Data Documentation

int lti::ioBMP::parameters::bitsPerPixel

bits per pixel (default value 24)

bool lti::ioBMP::parameters::compression

compress the data.

(RLE4 or RLE8 will be used if the number of bits are 4 or 8). The default value is false

int lti::ioBMP::parameters::quantColors

quantization of colors.

If 0 no quantization needed If >0 then a k-mean analysis of the colors will be made and the used color number will be reduce to quantColors (unused by now)

---

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

• ltiBMPFunctor.h