cvr::ioImageInterface::ioImageInterface::headerInformation Class Reference

Common header information block. More...

#include <cvrIOImageInterface.h>

Inheritance diagram for cvr::ioImageInterface::ioImageInterface::headerInformation:

[legend]

Collaboration diagram for cvr::ioImageInterface::ioImageInterface::headerInformation:

[legend]

List of all members.

Public Member Functions
	headerInformation ()
	headerInformation (const headerInformation &other)
virtual const std::string &	name () const
virtual headerInformation *	clone () const
virtual headerInformation *	newInstance () const
headerInformation &	copy (const headerInformation &other)
headerInformation &	operator= (const headerInformation &other)
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
std::string	type
ipoint	size
int	bpp
int	colorEntries

---

Detailed Description

Common header information block.

All inherited classes have to provide a way to get information from the file without reading it completely. The information can vary among the file formats, but usually this common data set can be obtained.

---

Constructor & Destructor Documentation

cvr::ioImageInterface::ioImageInterface::headerInformation::headerInformation

(

)

Default constructor.

cvr::ioImageInterface::ioImageInterface::headerInformation::headerInformation

(

const headerInformation &

other

)

Default constructor.

---

Member Function Documentation

virtual headerInformation* cvr::ioImageInterface::ioImageInterface::headerInformation::clone

(

)

const [virtual]

Returns a copy of this object.

Implements cvr::ioObject.

headerInformation& cvr::ioImageInterface::ioImageInterface::headerInformation::copy

(

const headerInformation &

other

)

Copy.

virtual const std::string& cvr::ioImageInterface::ioImageInterface::headerInformation::name

(

)

const [virtual]

Returns the name of this class.

Implements cvr::ioObject.

virtual headerInformation* cvr::ioImageInterface::ioImageInterface::headerInformation::newInstance

(

)

const [virtual]

Returns a copy of this object.

Implements cvr::ioObject.

headerInformation& cvr::ioImageInterface::ioImageInterface::headerInformation::operator=

(

const headerInformation &

other

)

Copy.

virtual bool cvr::ioImageInterface::ioImageInterface::headerInformation::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

Read the parameters from 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

This method has to be overloaded. If not it always returns false.

Reimplemented from cvr::ioObject.

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

This method has to be overloaded. If not it always returns false.

Reimplemented from cvr::ioObject.

---

Member Data Documentation

int cvr::ioImageInterface::ioImageInterface::headerInformation::bpp

Number of bits per pixel in the file.

int cvr::ioImageInterface::ioImageInterface::headerInformation::colorEntries

Number of color entries in an internal palette, which usually has to be less than 2^bpp, and zero if there is no palette.

ipoint cvr::ioImageInterface::ioImageInterface::headerInformation::size

Size of the image in the file.

std::string cvr::ioImageInterface::ioImageInterface::headerInformation::type

A std::string coding the data type.

It is usually a 3-characters long string.

---

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

• cvrIOImageInterface.h