lti::dataCodec::parameters Class Reference

The parameters for the class dataTransformer. More...

#include <ltiDataCodec.h>

Inheritance diagram for lti::dataCodec::parameters:

[legend]

List of all members.

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
codingDirection	direction
bool	useEOD

---

Detailed Description

The parameters for the class dataTransformer.

---

Constructor & Destructor Documentation

lti::dataCodec::parameters::parameters

(

)

default constructor

Reimplemented in lti::binarizationCodec::parameters.

lti::dataCodec::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented in lti::binarizationCodec::parameters.

lti::dataCodec::parameters::~parameters

(

)

destructor

Reimplemented in lti::binarizationCodec::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::dataCodec::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented in lti::binarizationCodec::parameters.

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

const char* lti::dataCodec::parameters::getTypeName

(

)

const

returns name of this type

Reimplemented in lti::binarizationCodec::parameters.

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

virtual bool lti::dataCodec::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 in lti::binarizationCodec::parameters.

virtual bool lti::dataCodec::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 in lti::binarizationCodec::parameters.

---

Member Data Documentation

codingDirection lti::dataCodec::parameters::direction

The direction of the coding.

bool lti::dataCodec::parameters::useEOD

If true, causes the encoding method to conclude the data block with an end-of-data marker, whose value depends on the actual coding method.

This parameter is not implemented at present.

---

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

• ltiDataCodec.h