cvr::ioBMP::ioBMP::parameters Class Reference

Parameter class of the ioBMP class. More...

#include <cvrIOBMP.h>

Inheritance diagram for cvr::ioBMP::ioBMP::parameters:

[legend]

Collaboration diagram for cvr::ioBMP::ioBMP::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
parameters &	copy (const parameters &other)
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () 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

---

Detailed Description

Parameter class of the ioBMP class.

---

Constructor & Destructor Documentation

cvr::ioBMP::ioBMP::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

cvr::ioBMP::ioBMP::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

---

Member Function Documentation

virtual parameters* cvr::ioBMP::ioBMP::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::ioImageInterface::ioImageInterface::parameters.

parameters& cvr::ioBMP::ioBMP::parameters::copy

(

const parameters &

other

)

Copy method.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

virtual const std::string& cvr::ioBMP::ioBMP::parameters::name

(

)

const [virtual]

Returns the name of this class.

Reimplemented from cvr::ioImageInterface::ioImageInterface::parameters.

virtual parameters* cvr::ioBMP::ioBMP::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::ioImageInterface::ioImageInterface::parameters.

virtual bool cvr::ioBMP::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 cvr::ioImageInterface::ioImageInterface::parameters.

virtual bool cvr::ioBMP::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 cvr::ioImageInterface::ioImageInterface::parameters.

---

Member Data Documentation

int cvr::ioBMP::ioBMP::parameters::bitsPerPixel

Bits per pixel.

Default value: 24

bool cvr::ioBMP::ioBMP::parameters::compression

Activate compression of the data.

RLE4 or RLE8 will be used if the number of bits are 4 or 8.

Default value: true.

---

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

• cvrIOBMP.h