vetFilterParameters Class Reference

This object is designed to store main filter's variables and (de)serialize data (from) to XML,. More...

#include <vetFilter.h>

Inheritance diagram for vetFilterParameters:

Public Types
enum	BUFFER_TYPE
	Selector of available buffer types in vetFilter class.
Public Member Functions
	vetFilterParameters ()
	Default constructor, call it in your constructor to init class.
virtual	~vetFilterParameters ()
	Default destructor.
VETRESULT	saveToXML (const char *filename)
	Initialize stored variables to default values, called also by constructor. Serialize class to XML file. Open file stream and call inherited saveToStreamXML() to save specific data structures.
VETRESULT	loadFromXML (const char *filename)
	Deserialize class from XML file. Open file stream and call inherited loadFromStreamXML() to load specific data structures.
virtual VETRESULT	saveToStreamXML (FILE *fp)=0
	Serialize class to XML format. Class' tag is <vetCoder_MOVParameters>.
virtual VETRESULT	loadFromStreamXML (FILE *fp)=0
	Deserialize class from XML format. Class' tag must be <vetCoder_MOVParameters>.
Protected Attributes
BUFFER_TYPE	currentBuffer
	Selector of current buffer in vetFilter class (useful for serialization).
Friends
class	vetFilter
	Makes protected variables (currentBuffer) accessible from vetFilter class.

---

Detailed Description

This object is designed to store main filter's variables and (de)serialize data (from) to XML,.

VETLib Framework 1.0.2 Copyright (C) Alessandro Polo 2006 http://www.ewgate.net/vetlib

Definition at line 57 of file vetFilter.h.

---

Member Function Documentation

virtual VETRESULT vetFilterParameters::loadFromStreamXML (  FILE *  fp  )  [pure virtual]

Deserialize class from XML format. Class' tag must be <vetCoder_MOVParameters>. Parameters: [in]  fp  input stream's pointer Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Implemented in vetCodec_BMPParameters, vetCodec_BMPParameters, vetCodec_IMGParameters, vetCodec_MOVParameters, vetCodec_MPEGParameters, vetCodec_XVIDParameters, vetDigitalFilterParameters, vetFilterColorParameters, vetFilterGeometricParameters, vetFilterNoiseChannelParameters, vetMultiplexerParameters, and vetCodecParameters. Referenced by loadFromXML().

int vetFilterParameters::loadFromXML (  const char *  filename  )

Deserialize class from XML file. Open file stream and call inherited loadFromStreamXML() to load specific data structures. Parameters: [in]  filename  input file name (NULL Terminated string) Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Definition at line 389 of file vetFilter.cpp. References loadFromStreamXML(), VETRET_OK, and VETRET_PARAM_ERR.

virtual VETRESULT vetFilterParameters::saveToStreamXML (  FILE *  fp  )  [pure virtual]

Serialize class to XML format. Class' tag is <vetCoder_MOVParameters>. Parameters: [in]  fp  output stream's pointer Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Implemented in vetCodec_BMPParameters, vetCodec_BMPParameters, vetCodec_IMGParameters, vetCodec_MOVParameters, vetCodec_MPEGParameters, vetCodec_XVIDParameters, vetDigitalFilterParameters, vetFilterColorParameters, vetFilterGeometricParameters, vetFilterNoiseChannelParameters, vetMultiplexerParameters, and vetCodecParameters. Referenced by saveToXML().

int vetFilterParameters::saveToXML (  const char *  filename  )

Initialize stored variables to default values, called also by constructor. Serialize class to XML file. Open file stream and call inherited saveToStreamXML() to save specific data structures. Parameters: [in]  filename  output file name (NULL Terminated string) Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Definition at line 358 of file vetFilter.cpp. References saveToStreamXML(), VETRET_INTERNAL_ERR, VETRET_OK, and VETRET_PARAM_ERR.

---

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

• vetFilter.h
• vetFilter.cpp

---