RuleBasedTopologySource Class Reference

This topology source holds and applies a set of rules for transforming one device topology into another one that may involve virtual and/or aggregate devices. More...

Inheritance diagram for RuleBasedTopologySource:

Classes

struct  Rule
 A rule that can transform parts of a topology. More...
 

Public Member Functions

 RuleBasedTopologySource (TopologySource &)
 Creates a RuleBasedTopologySource which wraps another TopologySource passed in here. More...
 
 ~RuleBasedTopologySource ()
 Destructor. More...
 
BlockTopology getCurrentTopology () const
 Returns the currently active topology. More...
 
void clearRules ()
 Clears the list of active rules. More...
 
void addRule (Rule *)
 Adds a rule to the list that will be applied. More...
 
- Public Member Functions inherited from TopologySource
virtual ~TopologySource ()
 Destructor. More...
 
void addListener (Listener *l)
 
void removeListener (Listener *l)
 
virtual void cancelAllActiveTouches () noexcept
 Invoke this to force touches-off on all physical devices. More...
 

Additional Inherited Members

- Protected Attributes inherited from TopologySource
juce::ListenerList< Listenerlisteners
 

Detailed Description

This topology source holds and applies a set of rules for transforming one device topology into another one that may involve virtual and/or aggregate devices.

Given an input PhysicalTopologySource and a set of Rule objects, this class will apply the rules and present the resulting topology to clients.

Constructor & Destructor Documentation

◆ RuleBasedTopologySource()

RuleBasedTopologySource::RuleBasedTopologySource ( TopologySource )

Creates a RuleBasedTopologySource which wraps another TopologySource passed in here.

◆ ~RuleBasedTopologySource()

RuleBasedTopologySource::~RuleBasedTopologySource ( )

Destructor.

Member Function Documentation

◆ getCurrentTopology()

BlockTopology RuleBasedTopologySource::getCurrentTopology ( ) const
virtual

Returns the currently active topology.

Implements TopologySource.

◆ clearRules()

void RuleBasedTopologySource::clearRules ( )

Clears the list of active rules.

Calling this method will cause an asynchronous topology update if the new rule-set results in a change to the topology.

Referenced by RuleBasedTopologySource::Rule::~Rule().

◆ addRule()

void RuleBasedTopologySource::addRule ( Rule )

Adds a rule to the list that will be applied.

The object passed-in will be owned by this object, so don't keep any references to it. Calling this method will cause an asynchronous topology update if the new rule-set results in a change to the topology.

Referenced by RuleBasedTopologySource::Rule::~Rule().


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