MPxCacheConfigRuleFilter Class Reference

#include <MPxCacheConfigRuleFilter.h>

Class Description

Proxy class for defining a new caching rule filter.

Caching rules are defined through the cacheEvaluator command. They can be built using filter/action pairs. This class allows defining a custom caching rule filter.

See also: MCacheConfigRuleRegistry

+ Examples:

Public Member Functions

virtual void preRulesExecution ()
 Called when cache configuration rule application starts. More...
 
virtual void postRulesExecution ()
 Called when cache configuration rule application stops. More...
 
virtual bool isMatch (const MEvaluationNode &evalNode)
 Will be called for each evaluation node when filter/action rules are applied for the cache configuration. More...
 

Member Function Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN void preRulesExecution ( )
virtual

Called when cache configuration rule application starts.

Note: this default implementation does nothing, so it is not necessary to call it from derived classes.

void postRulesExecution ( )
virtual

Called when cache configuration rule application stops.

Note: this default implementation does nothing, so it is not necessary to call it from derived classes.

bool isMatch ( const MEvaluationNode evalNode)
virtual

Will be called for each evaluation node when filter/action rules are applied for the cache configuration.

If the filter matches (returns true), then the associated action will be called.

Note: This default implementation returns false for all nodes and does not need to be called by derived classes.

Parameters
[in]evalNodethe evaluation node to match
Returns
  • true the evaluation node matches the filter
  • false the evaluation node does not match the filter
+ Examples:

The documentation for this class was generated from the following files:
  • MPxCacheConfigRuleFilter.h
  • MPxCacheConfigRuleFilter.cpp