scim  1.4.9
scim::FilterManager Class Reference

#include <scim_filter_manager.h>

List of all members.

Public Member Functions

 FilterManager (const ConfigPointer &config)
 ~FilterManager ()
unsigned int number_of_filters () const
 Get the total number of Filters supported by all filter modules.
bool get_filter_info (unsigned int idx, FilterInfo &info) const
 Get the information of a specific filter by its index.
bool get_filter_info (const String &uuid, FilterInfo &info) const
 Get the information of a specific filter by its uuid.
void clear_all_filter_settings () const
 Clear all Filter settings for IMEngines.
size_t get_filters_for_imengine (const String &uuid, std::vector< String > &filters) const
 Get a list of Filters binded to an IMEngine.
void set_filters_for_imengine (const String &uuid, const std::vector< String > &filters) const
 Bind one or more Filters to an IMEngine.
size_t get_filtered_imengines (std::vector< String > &imengines) const
 Get a list of imengines which have one or more filters attached.
FilterFactoryPointer create_filter (unsigned int idx) const
 Create a FilterFactory according to its index.
FilterFactoryPointer create_filter (const String &uuid) const
 Create a FilterFactory according to its UUID.
IMEngineFactoryPointer attach_filters_to_factory (const IMEngineFactoryPointer &factory) const
 Attach all binded Filters to an IMEngineFactory object.

Constructor & Destructor Documentation

scim::FilterManager::FilterManager ( const ConfigPointer config)

Member Function Documentation

Get the total number of Filters supported by all filter modules.

bool scim::FilterManager::get_filter_info ( unsigned int  idx,
FilterInfo info 
) const

Get the information of a specific filter by its index.

Parameters:
idxThe index of the filter, must between 0 to number_of_filters () - 1.
infoThe FilterInfo object to store the information.
Returns:
true if this filter is ok and the information is stored correctly.
bool scim::FilterManager::get_filter_info ( const String uuid,
FilterInfo info 
) const

Get the information of a specific filter by its uuid.

Parameters:
uuidThe uuid of the filter.
infoThe FilterInfo object to store the information.
Returns:
true if this filter is ok and the information is stored correctly.

Clear all Filter settings for IMEngines.

size_t scim::FilterManager::get_filters_for_imengine ( const String uuid,
std::vector< String > &  filters 
) const

Get a list of Filters binded to an IMEngine.

Parameters:
uuidThe uuid of the IMEngine to be queried.
filtersThe list of Filters' UUIDs binded to the IMEngine will be stored here.
Returns:
How many filters binded to this IMEngine.
void scim::FilterManager::set_filters_for_imengine ( const String uuid,
const std::vector< String > &  filters 
) const

Bind one or more Filters to an IMEngine.

Parameters:
uuidThe uuid of the IMEngine to be binded.
filtersThe list of Filters' UUIDs to be binded to the IMEngine.
size_t scim::FilterManager::get_filtered_imengines ( std::vector< String > &  imengines) const

Get a list of imengines which have one or more filters attached.

Parameters:
imenginesThe UUIDs of filtered imengines will be stored here.
Returns:
How many imengines are being filtered.

Create a FilterFactory according to its index.

Parameters:
idxThe index of the filter to be created, must be less than number_of_filters() - 1.
Returns:
The pointer of the FilterFactory object.

Create a FilterFactory according to its UUID.

Parameters:
uuidThe UUID of the filter to be created.
Returns:
The pointer of the FilterFactory object.

Attach all binded Filters to an IMEngineFactory object.

Parameters:
factoryThe pointer to an IMEngineFactory object which would be filtered.
Returns:
New pointer of IMEngineFactory object which has Filters binded.

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