vetCodec_BMPParameters Class Reference

Inheritance diagram for vetCodec_BMPParameters:


Public Member Functions
	vetCodec_BMPParameters ()
	vetCodec_BMPParameters (const char *filename, vetCodec_BMP::FileFormat format=vetCodec_BMP::FORMAT_BMP_ANY)
	~vetCodec_BMPParameters ()
void	reset ()
void	setFileNameIndex (int base=-1)
	Set current index for filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented.
void	setFileNameProgression (bool value=true)
	Enable or disable filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented (output14.bmp).
void	setAutoOutputEnabled (bool value=true)
	Enable or disable auto input feature,.
void	setAutoInputEnabled (bool value=true)
void	setDoBuffering (bool value=true)
void	setFileName (const char *filename)
void	setFileFormat (vetCodec_BMP::FileFormat format=vetCodec_BMP::FORMAT_BMP_24)
	Set current BMP format.
int	getFileNameIndex ()
	Read current file name index, used in file name progression routines.
bool	isFileNameProgressionEnabled ()
bool	isAutoInputEnabled ()
bool	isAutoOutputEnabled ()
bool	isBufferingEnabled ()
void	getFileName (char *filename)
	Read base filename, if progression is enabled it's the base fixed name.
void	getFileNameCurrent (char *filename)
	Read current filename, if progression is enabled it's the base fixed name + current index + bmp extension.
vetCodec_BMP::FileFormat	getFileFormat ()
	Read current bitmap encoding/decoding format.
int	saveToStreamXML (FILE *fp)
	Serialize class to XML format. Class' tag is <vetCodec_MOVParameters>.
int	loadFromStreamXML (FILE *fp)
	Deserialize class from XML format. Class' tag must be <vetCodec_MOVParameters>.
	~vetCodec_BMPParameters ()
void	setFileNameIndex (int base=-1)
	Set current index for filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented.
void	setFileNameProgression (bool value=true)
	Enable or disable filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented (output14.bmp).
void	setAutoOutputEnabled (bool value=true)
	Enable or disable auto input feature,.
void	setAutoInputEnabled (bool value=true)
void	setDoBuffering (bool value=true)
void	setFileName (const char *filename)
void	setFileFormat (vetCodec_BMP::FileFormat format=vetCodec_BMP::FORMAT_BMP_24)
	Set current BMP format.
int	getFileNameIndex ()
	Read current file name index, used in file name progression routines.
bool	isFileNameProgressionEnabled ()
bool	isAutoInputEnabled ()
bool	isAutoOutputEnabled ()
bool	isBufferingEnabled ()
void	getFileName (char *filename)
	Read base filename, if progression is enabled it's the base fixed name.
void	getFileNameCurrent (char *filename)
	Read current filename, if progression is enabled it's the base fixed name + current index + bmp extension.
vetCodec_BMP::FileFormat	getFileFormat ()
	Read current bitmap encoding/decoding format.
VETRESULT	saveToStreamXML (FILE *fp)
	Serialize class to XML format. Class' tag is <vetCodec_MOVParameters>.
VETRESULT	loadFromStreamXML (FILE *fp)
	Deserialize class from XML format. Class' tag must be <vetCodec_MOVParameters>.
Protected Attributes
int	fileNameIndex
char	fileNameBase [128]
bool	fileNameProgression
bool	autoOuput
bool	autoInput
bool	doBuffering
vetCodec_BMP::FileFormat	fileFormat
Friends
class	vetCodec_BMP

Detailed Description

Definition at line 653 of file vetCodec_BMP.h.

Member Function Documentation

vetCodec_BMP::FileFormat vetCodec_BMPParameters::getFileFormat ( void ) [inline]

Read current bitmap encoding/decoding format.

Returns:
Current I/O BMP format.

See also:
FileFormat
fileFormat

Definition at line 855 of file vetCodec_BMP2.h.
References fileFormat.

void vetCodec_BMPParameters::getFileName ( char * filename )

Read base filename, if progression is enabled it's the base fixed name.

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

void vetCodec_BMPParameters::getFileNameCurrent ( char * filename )

Read current filename, if progression is enabled it's the base fixed name + current index + bmp extension.

Parameters:

[out] Char Array to store current filename [Max size 64 chars]

See also:
fileNameBase

int vetCodec_BMPParameters::getFileNameIndex ( ) [inline]

Read current file name index, used in file name progression routines.

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 772 of file vetCodec_BMP2.h.
References fileNameIndex.

int vetCodec_BMPParameters::getFileNameIndex ( ) [inline]

Read current file name index, used in file name progression routines.

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 775 of file vetCodec_BMP.h.
References fileNameIndex.

bool vetCodec_BMPParameters::isAutoInputEnabled ( ) [inline]

Returns:
VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 793 of file vetCodec_BMP2.h.
References autoInput.

bool vetCodec_BMPParameters::isAutoOutputEnabled ( ) [inline]

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 807 of file vetCodec_BMP2.h.
References autoOuput.

bool vetCodec_BMPParameters::isBufferingEnabled ( ) [inline]

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 821 of file vetCodec_BMP2.h.
References doBuffering.

bool vetCodec_BMPParameters::isFileNameProgressionEnabled ( ) [inline]

Returns:
true if filename progression is enabled.

See also:
fileNameProgression

Definition at line 781 of file vetCodec_BMP2.h.
References fileNameProgression.

bool vetCodec_BMPParameters::isFileNameProgressionEnabled ( ) [inline]

Returns:
true if filename progression is enabled.

See also:
fileNameProgression

Definition at line 784 of file vetCodec_BMP.h.
References fileNameProgression.

VETRESULT vetCodec_BMPParameters::loadFromStreamXML ( FILE * fp ) [virtual]

Deserialize class from XML format. Class' tag must be <vetCodec_MOVParameters>.

Parameters:

[in] fp input stream's pointer

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else.

Implements vetCodecParameters.

int vetCodec_BMPParameters::loadFromStreamXML ( FILE * fp ) [virtual]

Deserialize class from XML format. Class' tag must be <vetCodec_MOVParameters>.

Parameters:

[in] fp input stream's pointer

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else.

Implements vetCodecParameters.
Definition at line 757 of file vetCodec_BMP.cpp.
References autoInput, autoOuput, doBuffering, fileNameBase, fileNameIndex, and VETRET_OK.

VETRESULT vetCodec_BMPParameters::saveToStreamXML ( FILE * fp ) [virtual]

Serialize class to XML format. Class' tag is <vetCodec_MOVParameters>.

Parameters:

[in] fp output stream's pointer

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else.

Implements vetCodecParameters.

int vetCodec_BMPParameters::saveToStreamXML ( FILE * fp ) [virtual]

Serialize class to XML format. Class' tag is <vetCodec_MOVParameters>.

Parameters:

[in] fp output stream's pointer

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else.

Implements vetCodecParameters.
Definition at line 724 of file vetCodec_BMP.cpp.
References autoInput, autoOuput, doBuffering, fileFormat, fileNameBase, fileNameIndex, VETRET_INTERNAL_ERR, VETRET_OK, and VETRET_PARAM_ERR.

void vetCodec_BMPParameters::setAutoInputEnabled ( bool value = true ) [inline]

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 725 of file vetCodec_BMP2.h.
References autoInput.

void vetCodec_BMPParameters::setAutoOutputEnabled ( bool value = true ) [inline]

Enable or disable auto input feature,.

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 711 of file vetCodec_BMP2.h.
References autoOuput.

void vetCodec_BMPParameters::setDoBuffering ( bool value = true ) [inline]

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 739 of file vetCodec_BMP2.h.
References doBuffering.

void vetCodec_BMPParameters::setDoBuffering ( bool value = true ) [inline]

Parameters:

[in] @return VETRET_OK if everything is fine, VETRET_PARAM_ERR if frame is not valid, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

Note:

See also:

Definition at line 742 of file vetCodec_BMP.h.
References doBuffering.
Referenced by reset().

void vetCodec_BMPParameters::setFileFormat ( vetCodec_BMP::FileFormat format = vetCodec_BMP::FORMAT_BMP_24 ) [inline]

Set current BMP format.

Parameters:

[in] format BMP format enumaration.

See also:
FileFormat

Definition at line 759 of file vetCodec_BMP2.h.
References fileFormat.

void vetCodec_BMPParameters::setFileName ( const char * filename )

Parameters:

[in] @note

See also:

void vetCodec_BMPParameters::setFileName ( const char * filename )

Parameters:

[in] @note

See also:

Definition at line 712 of file vetCodec_BMP.cpp.
References fileNameBase.
Referenced by vetCodec_BMPParameters().

void vetCodec_BMPParameters::setFileNameIndex ( int base = -1 ) [inline]

Set current index for filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented.

Parameters:

[in] base current filename index as integer value.

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

See also:

Definition at line 687 of file vetCodec_BMP2.h.
References fileNameIndex.

void vetCodec_BMPParameters::setFileNameIndex ( int base = -1 ) [inline]

Set current index for filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented.

Parameters:

[in] base current filename index as integer value.

Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR or VETRET_ILLEGAL_USE else.

See also:

Definition at line 690 of file vetCodec_BMP.h.
References fileNameIndex.
Referenced by reset().

void vetCodec_BMPParameters::setFileNameProgression ( bool value = true ) [inline]

Enable or disable filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented (output14.bmp).

Parameters:

[in] value true to enable file name progression.

Definition at line 697 of file vetCodec_BMP2.h.
References fileNameProgression.

void vetCodec_BMPParameters::setFileNameProgression ( bool value = true ) [inline]

Enable or disable filename progression, for example: basefile name is "output", index is 13 so filename is output13.bmp, if filename progression is enabled, when an operation is done onto file, idex is incremented (output14.bmp).

Parameters:

[in] value true to enable file name progression.

Definition at line 700 of file vetCodec_BMP.h.
References fileNameProgression.
Referenced by reset().

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

Generated on Tue Jan 24 11:59:24 2006 for VETLib by

1.4.4

vetCodec_BMPParameters Class Reference

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Function Documentation