All Categories Class Hierarchy This Category Previous Next Indexes
Product Class CATVPMFilterManager
CATVPMFilterManager
public class CATVPMFilterManager
Manage filters used during PSN expand.
Following convention is used for naming parameters.
Parameter names prefixed by:
- i are input parameters
- o are ouput parameters
- io are input/output parameters
Constructor and Destructor Index
- o
CATVPMFilterManager()
- Constructor
Method Index
- o
AddFilter(char*,char*,char*,char*)
- Add a new filter.
- o
GetFilterClass(int)
- Get the name of the class of a filter by its number
- o
GetFilterLibrary(int)
- Get the name of the library of a filter by its number
- o
GetFilterParameter(int)
- Get the parameter of a filter by its number
- o
GetFiltername(int)
- Get the name of a filter by its number
- o
GetNbFilter()
- Get the number of filters defined
- o
InsertFilter(int,char*,char*,char*,char*)
- Add a new filter
- o
RemoveFilter(char*)
- Remove a filter
- o
RemoveFilter(int)
- Removes a filter.
Constructor and Destructor
o CATVPMFilterManager
| public CATVPMFilterManager( | ) |
-
Constructor
Methods
o AddFilter
| public int AddFilter( | const char* | iName, |
| const char* | iLibrary, |
| const char* | iClassName, |
| const char* | iParam | = 0) |
-
Add a new filter. It will be executed after all filters already declared.
- Parameters:
-
- iName
- name of the filter
- iLibrary
- library where the filter is implemented
- iClassName
- implementation class of the filter (inherits of CATVPMFilter)
- iParam
- parameter for the filter (optional)
if used, class must inherit from CATVPMFilterWithParameter
- Returns:
- 1 filter is added
0 filter already exists (not added)
-1 No current filter manager
o GetFilterClass
| public const char * GetFilterClass( | const int | iNum) |
-
Get the name of the class of a filter by its number
- Parameters:
-
- iNum
- filter number
- Returns:
- name of the class
o GetFilterLibrary
| public const char * GetFilterLibrary( | const int | iNum) |
-
Get the name of the library of a filter by its number
- Parameters:
-
- iNum
- filter number
- Returns:
- name of the library
o GetFilterParameter
| public const char * GetFilterParameter( | const int | iNum) |
-
Get the parameter of a filter by its number
- Parameters:
-
- iNum
- filter number
- Returns:
- parameter
o GetFiltername
| public const char * GetFiltername( | const int | iNum) |
-
Get the name of a filter by its number
- Parameters:
-
- iNum
- filter number
- Returns:
- filter name
o GetNbFilter
| public int GetNbFilter( | )const |
-
Get the number of filters defined
- Returns:
- number of filters
o InsertFilter
| public int InsertFilter( | const int | iNum, |
| const char* | iName, |
| const char* | iLibrary, |
| const char* | iClassName, |
| const char* | iParam | = 0) |
-
Add a new filter
- Parameters:
-
- iNum
- index of the filter (position in the filters list)
- iName
- name of the filter
- iLibrary
- library where the filter is implemented
- iClassName
- implementation class of the filter (inherits of CATVPMFilter)
- iParam
- parameter for the filter (optional)
if used, class must inherit from CATVPMFilterWithParameter
- Returns:
- 1 filter is added
0 filter already exists (not added)
-1 No current filter manager
o RemoveFilter
| public int RemoveFilter( | const char* | iName) |
-
Remove a filter
- Parameters:
-
- iName
- name of the filter to remove
- Returns:
- 1 filter is removed
0 filter does not exist (so not removed)
-1 it is forbidden to remove this filter
-2 no current filter manager
o RemoveFilter
| public int RemoveFilter( | const int | iNum) |
-
Removes a filter.
- Parameters:
-
- iNum
- position of the filter to remove
- Returns:
- 1 filter is removed
0 filter does not exist (so not removed)
-1 it is forbidden to remove this filter
-2 no current filter manager
This object is included in the file: CATVPMFilterManager.h
If needed, your Imakefile.mk should include the module: LV0PSCFG