vetCodec_IMGParameters Class Reference

Inheritance diagram for vetCodec_IMGParameters:

Public Member Functions
	vetCodec_IMGParameters ()
	Read current bitmap encoding/decoding format.
	vetCodec_IMGParameters (char *filename)
	~vetCodec_IMGParameters ()
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)
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.
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
Friends
class	vetCodec_IMG

---

Detailed Description

Definition at line 59 of file vetCodec_IMG.h.

---

Constructor & Destructor Documentation

vetCodec_IMGParameters::vetCodec_IMGParameters (   )

Read current bitmap encoding/decoding format. Returns: Current I/O BMP format. See also: FileFormat fileFormat Definition at line 693 of file vetCodec_IMG.cpp. References reset().

---

Member Function Documentation

void vetCodec_IMGParameters::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: Definition at line 722 of file vetCodec_IMG.cpp. References fileNameBase.

void vetCodec_IMGParameters::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_IMGParameters::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 171 of file vetCodec_IMG.h. References fileNameIndex.

bool vetCodec_IMGParameters::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 192 of file vetCodec_IMG.h. References autoInput.

bool vetCodec_IMGParameters::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 206 of file vetCodec_IMG.h. References autoOuput.

bool vetCodec_IMGParameters::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 220 of file vetCodec_IMG.h. References doBuffering.

bool vetCodec_IMGParameters::isFileNameProgressionEnabled (   )  [inline]

Returns: true if filename progression is enabled. See also: fileNameProgression Definition at line 180 of file vetCodec_IMG.h. References fileNameProgression.

int vetCodec_IMGParameters::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 758 of file vetCodec_IMG.cpp. References autoInput, autoOuput, doBuffering, fileNameBase, fileNameIndex, and VETRET_OK.

int vetCodec_IMGParameters::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 728 of file vetCodec_IMG.cpp. References autoInput, autoOuput, doBuffering, fileNameBase, fileNameIndex, VETRET_INTERNAL_ERR, VETRET_OK, and VETRET_PARAM_ERR.

void vetCodec_IMGParameters::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 133 of file vetCodec_IMG.h. References autoInput. Referenced by reset().

void vetCodec_IMGParameters::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 119 of file vetCodec_IMG.h. References autoOuput. Referenced by reset().

void vetCodec_IMGParameters::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 147 of file vetCodec_IMG.h. References doBuffering. Referenced by reset().

void vetCodec_IMGParameters::setFileName (  const char *  filename  )

Parameters: [in]  @note  See also: Definition at line 716 of file vetCodec_IMG.cpp. References fileNameBase. Referenced by vetCodec_IMGParameters().

void vetCodec_IMGParameters::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 95 of file vetCodec_IMG.h. References fileNameIndex. Referenced by reset().

void vetCodec_IMGParameters::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 105 of file vetCodec_IMG.h. References fileNameProgression. Referenced by reset().

---

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

• vetCodec_IMG.h
• vetCodec_IMG.cpp

---