lti::identityCodec Class Reference

This is a dummy codec that does absolutely nothing. More...

#include <ltiIdentityCodec.h>

Inheritance diagram for lti::identityCodec:

[legend]

Collaboration diagram for lti::identityCodec:

[legend]

List of all members.

Public Member Functions
	identityCodec ()
	identityCodec (const parameters &par)
	identityCodec (const identityCodec &other)
virtual	~identityCodec ()
virtual const char *	getTypeName () const
identityCodec &	copy (const identityCodec &other)
identityCodec &	operator= (const identityCodec &other)
virtual functor *	clone () const
Protected Member Functions
virtual bool	decodeImplementation (const buffer &src, buffer &dest, int nsrc, int &ndest) const
virtual bool	encodeImplementation (const buffer &src, buffer &dest, int nsrc, int &ndest) const

---

Detailed Description

This is a dummy codec that does absolutely nothing.

It is convenient for using "no compression" as just one of many compression methods.

---

Constructor & Destructor Documentation

lti::identityCodec::identityCodec

(

)

default constructor

lti::identityCodec::identityCodec

(

const parameters &

par

)

Construct a functor using the given parameters.

lti::identityCodec::identityCodec

(

const identityCodec &

other

)

copy constructor

Parameters:

other

the object to be copied

virtual lti::identityCodec::~identityCodec

(

)

[virtual]

destructor

---

Member Function Documentation

virtual functor* lti::identityCodec::clone

(

)

const [virtual]

returns a pointer to a clone of this functor.

Implements lti::functor.

identityCodec& lti::identityCodec::copy

(

const identityCodec &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::dataCodec.

virtual bool lti::identityCodec::decodeImplementation	(	const buffer &	src,
		buffer &	dest,
		int	nsrc,
		int &	ndest
	)			const [protected, virtual]

Implementation of on-copy data decoder.

This method must not, under no circumstances, resize the destination vector.

Returns:

true if the decoding could be performed successfully.

Parameters:

	src	the source of the data.
	dest	the destination for the decoded data.
	nsrc	tells how many elements of the src vector must be decoded.
	ndest	tells how many elements of the destination vector can be used for the decoded data. When the method returns, this value tells how many elements were actually used, or notEnoughSpace if not enough elements were available.

Implements lti::dataCodec.

virtual bool lti::identityCodec::encodeImplementation	(	const buffer &	src,
		buffer &	dest,
		int	nsrc,
		int &	ndest
	)			const [protected, virtual]

Implementation of on-copy data encoder.

This method must not, under no circumstances, resize the destination vector.

Returns:

true if the decoding could be performed successfully.

Parameters:

	src	the source of the data.
	dest	the destination for the encoded data.
	nsrc	tells how many elements of the src vector must be decoded.
	ndest	tells how many elements of the destination vector can be used for the decoded data. When the method returns, this value tells how many elements were actually used, or notEnoughSpace if not enough elements were available.

Implements lti::dataCodec.

virtual const char* lti::identityCodec::getTypeName

(

)

const [virtual]

returns the name of this type ("identityCodec")

Reimplemented from lti::dataCodec.

identityCodec& lti::identityCodec::operator=

(

const identityCodec &

other

)

alias for copy member

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::dataCodec.

---

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

• ltiIdentityCodec.h