cvr::loadImageList::loadImageList::parameters Class Reference

The parameters for the class loadImageList. More...

#include <cvrLoadImageList.h>

Inheritance diagram for cvr::loadImageList::loadImageList::parameters:

[legend]

Collaboration diagram for cvr::loadImageList::loadImageList::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
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
bool	continueOnError
std::string	fileType

---

Detailed Description

The parameters for the class loadImageList.

---

Constructor & Destructor Documentation

cvr::loadImageList::loadImageList::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::parametersManager::parametersManager::parameters.

cvr::loadImageList::loadImageList::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::parametersManager::parametersManager::parameters.

cvr::loadImageList::loadImageList::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::parametersManager::parametersManager::parameters.

---

Member Function Documentation

virtual parameters* cvr::loadImageList::loadImageList::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::parametersManager::parametersManager::parameters.

parameters& cvr::loadImageList::loadImageList::parameters::copy

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from cvr::parametersManager::parametersManager::parameters.

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

(

)

const [virtual]

Returns the complete name of the parameters class.

Implements cvr::parametersManager::parametersManager::parameters.

virtual parameters* cvr::loadImageList::loadImageList::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::parametersManager::parametersManager::parameters.

parameters& cvr::loadImageList::loadImageList::parameters::operator=

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from cvr::parametersManager::parametersManager::parameters.

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

Reimplemented from cvr::parametersManager::parametersManager::parameters.

virtual bool cvr::loadImageList::loadImageList::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::parametersManager::parametersManager::parameters.

---

Member Data Documentation

bool cvr::loadImageList::loadImageList::parameters::continueOnError

If true errors on reading an image file are ignored and the next image is tried.

This can be useful for batch processing.

Default: false

std::string cvr::loadImageList::loadImageList::parameters::fileType

Determines the filetypes that should be loaded.

Available filetypes can be found by looking at the subclasses of cvr::IOImageInterface. Just use the typical three letter abbreviations, e.g. PNG for portable network graphics. You can also use ALL to load all available file types.

Default: "ALL"

---

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

• cvrLoadImageList.h