cvr::ioJPEG::ioJPEG::parameters Class Reference

Parameter class of ioJPEG. More...

#include <cvrIOJPEG.h>

Inheritance diagram for cvr::ioJPEG::ioJPEG::parameters:

[legend]

Collaboration diagram for cvr::ioJPEG::ioJPEG::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
parameters &	copy (const parameters &other)
parameters &	operator= (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
int	quality
bool	progressive
std::string	comment
int	rowsPerRestart

---

Detailed Description

Parameter class of ioJPEG.

---

Constructor & Destructor Documentation

cvr::ioJPEG::ioJPEG::parameters::parameters

(

)

Default constructor.

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

cvr::ioJPEG::ioJPEG::parameters::parameters

(

const parameters &

other

)

copy constructor

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

---

Member Function Documentation

virtual parameters* cvr::ioJPEG::ioJPEG::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

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

parameters& cvr::ioJPEG::ioJPEG::parameters::copy

(

const parameters &

other

)

Copy member.

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

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

(

)

const [virtual]

Returns the name of this class.

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

virtual parameters* cvr::ioJPEG::ioJPEG::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

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

parameters& cvr::ioJPEG::ioJPEG::parameters::operator=

(

const parameters &

other

)

Copy operator.

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

virtual bool cvr::ioJPEG::ioJPEG::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::ioJPEG::ioJPEG::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

std::string cvr::ioJPEG::ioJPEG::parameters::comment

Save a comment chunk in the file.

Default is an empty string.

bool cvr::ioJPEG::ioJPEG::parameters::progressive

Save in progressive or sequential mode.

Default is sequential mode (false).

int cvr::ioJPEG::ioJPEG::parameters::quality

Determines the compression of the image when saved.

Valid values range from 1 to 100. Default value is 75.

int cvr::ioJPEG::ioJPEG::parameters::rowsPerRestart

Number of rows between restart markers (0 = no restart markers) when saving.

Default is 0.

---

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

• cvrIOJPEG.h