lti::loadImageList::parameters Class Reference

the parameters for the class loadImageList More...

#include <ltiLoadImageList.h>

Inheritance diagram for lti::loadImageList::parameters:

[legend]

Collaboration diagram for lti::loadImageList::parameters:

[legend]

List of all members.

Public Types
enum	eOperationMode { ListFileName, DirName, NameList }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eOperationMode	mode
std::string	dirName
std::string	listFileName
std::list< std::string >	nameList
bool	skipErrors

---

Detailed Description

the parameters for the class loadImageList

---

Member Enumeration Documentation

enum lti::loadImageList::parameters::eOperationMode

Operation modes.

Enumerator:

ListFileName	read all images given in a textfile, see listFileName
DirName	read all image in a directory, see dirName
NameList	read all images in the list, see nameList

---

Constructor & Destructor Documentation

lti::loadImageList::parameters::parameters

(

)

default constructor

Reimplemented from lti::ioFunctor::parameters.

Reimplemented in lti::loadVectorImageList::parameters.

lti::loadImageList::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::ioFunctor::parameters.

Reimplemented in lti::loadVectorImageList::parameters.

lti::loadImageList::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::loadVectorImageList::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::loadImageList::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::ioFunctor::parameters.

Reimplemented in lti::loadVectorImageList::parameters.

parameters& lti::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 lti::ioFunctor::parameters.

Reimplemented in lti::loadVectorImageList::parameters.

const char* lti::loadImageList::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::ioFunctor::parameters.

Reimplemented in lti::loadVectorImageList::parameters.

parameters& lti::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 in lti::loadVectorImageList::parameters.

virtual bool lti::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 lti::ioFunctor::parameters.

Reimplemented in lti::loadVectorImageList::parameters.

virtual bool lti::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 lti::ioFunctor::parameters.

Reimplemented in lti::loadVectorImageList::parameters.

---

Member Data Documentation

std::string lti::loadImageList::parameters::dirName

Name of a directory containing images, e.g.

"/home/fooman/myImages/"

std::string lti::loadImageList::parameters::listFileName

Filename of a text file containing filenames of images.

Each row contains one filename only. The comment character is the semi-colon ';'. All text behind a semi-colon is regarded as comment. Such a file could look like this:

 ; some images to read
 /home/fooman/pics1/image1.png
 ;/home/fooman/pics1/image2.png
 /home/fooman/pics2/2.BMP
 /home/fooman/pics1/image1.jpg; another image

The functor would read the images:

• /home/fooman/pics1/image1.png
• /home/fooman/pics2/2.BMP
• /home/fooman/pics1/image1.jpg

eOperationMode lti::loadImageList::parameters::mode

Determines where the functor expects to find the filenames of the images to load.

There are three possibilities:

• ListFileName: The string listFileName contains the name of a textfile which contains the filenames of images to be selected for later loading. See listFileName for the format of the textfile
• DirName: The string dirName must contain the the path of a directory which contains image files. All files ending in '.jpg', '.jpeg', '.png' or '.bmp' are selected for later loading no matter whether upper or lower case.
• NameList: nameList is a list of strings, where each string is a filename of an image.

std::list<std::string> lti::loadImageList::parameters::nameList

Each entry in the list contains the full filename of an image.

bool lti::loadImageList::parameters::skipErrors

If reading an image fails and skipErrors is:

• true: The next available filename is tried.

The apply method returns false and sets the status string.

• false: The image is empty, the apply method returns false and the status string is set.

The default is false;

---

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

• ltiLoadImageList.h