Free Electron
Public Member Functions | List of all members
fe::ext::SelectorI Class Reference

Determine the Records that match a critera, such as shapes. More...

#include <SelectorI.h>

Inheritance diagram for fe::ext::SelectorI:
Inheritance graph
[legend]

Public Member Functions

virtual void configure (const Record &rCriteria, const sp< FilterI > &rspFilter)
 Configure selection based on a single criteria. More...
 
virtual void configure (const sp< RecordGroup > &rspCriteria, const sp< FilterI > &rspFilter, BWORD cumulative)
 Configure selection based on a group of criteria. More...
 
- Public Member Functions inherited from fe::ext::HandlerI
virtual void handleBind (sp< SignalerI > spSignalerI, sp< Layout > spLayout)
 
virtual void handle (Record &signal)
 
virtual void handleSignal (Record &signal, sp< SignalerI > spSignalerI)
 
- Public Member Functions inherited from fe::Component
const Stringname (void) const
 Return the components chosen name. More...
 
const String verboseName (void) const
 Return the annotated chosen name. More...
 
void setName (const String &name)
 Rename the component to anything you want. More...
 
hp< Registryregistry (void) const
 Get the Registry that created this component. More...
 
void adjoin (sp< Component > spComponent)
 Tie this component's lifetime to another. More...
 
sp< Componentcreate (const String &implementation, BWORD quiet=FALSE) const
 Convienience function to registry()->create() More...
 
void disjoin (void)
 Untie component from Hub, if connected. More...
 
String factoryName (void)
 
void setLibrary (sp< Library > spLibrary)
 Store a reference to the library used to instantiate this component. More...
 
sp< Librarylibrary (void)
 Get the library that created the component. More...
 
void setFactoryIndex (I32 a_factoryIndex)
 Set the library's factory index. More...
 
I32 factoryIndex (void)
 Get the library's factory index. More...
 
void setSingleton (BWORD set)
 Specify whether component is a singleton. More...
 
BWORD isSingleton (void)
 Return whether component is a singleton. More...
 
virtual void acquire (void)
 Specialized reference increment. More...
 
virtual void release (void)
 Specialized reference decrement. More...
 
- Public Member Functions inherited from fe::Handled< Component >
const hp< Component > & getHandle (void) const
 Get a safe handle to this object. More...
 
- Public Member Functions inherited from fe::Protectable
virtual I32 protection (void) const
 
virtual void protect (void)
 
virtual void unprotect (void)
 
virtual Protectableclone (Protectable *pInstance=NULL)
 
- Public Member Functions inherited from fe::Counted
virtual void acquire (int &rCount)
 Increment the reference count (and get the count) More...
 
virtual void abandon (void)
 Decrement the reference count. More...
 
int count (void) const
 Return the count of references. More...
 
void setName (const String &)
 
void trackReference (void *pReference, String what)
 
void untrackReference (void *pReference)
 
void registerRegion (void *pT, U32 bytes)
 
- Public Member Functions inherited from fe::Initialized
void initializeAll (void)
 
void setActive (bool a_active)
 

Additional Inherited Members

- Static Public Member Functions inherited from fe::Counted
static String reportTracker (void)
 
static U32 trackerCount (void)
 
- Protected Types inherited from fe::Initialized
typedef void(* InitializeFunction) (Initialized *)
 
- Protected Member Functions inherited from fe::Handled< Component >
void abandonHandle (void)
 
- Protected Member Functions inherited from fe::Counted
int releaseInternal (void)
 Decrement the reference count. More...
 
void suppressReport (void)
 
- Protected Member Functions inherited from fe::Initialized
void addInitializer (InitializeFunction function)
 

Detailed Description

Determine the Records that match a critera, such as shapes.

As a HandlerI, marks the subset of the input that meets the criteria. The action of "marking" is determined by the specific implementation.

The handle function will access the Record argument with an Operator AccessorSet, specifically looking for input, output, and choice.

If output field is valid, it is populated with the matched records as a subset of the input field.

If choice field is valid, some distinguished "best matching" Record will be determined and set.

A FilterI, if provided, only permits records that pass that given arbitrary test.

Member Function Documentation

◆ configure() [1/2]

virtual void fe::ext::SelectorI::configure ( const Record rCriteria,
const sp< FilterI > &  rspFilter 
)
inlinevirtual

Configure selection based on a single criteria.

Reimplemented in fe::ext::ShapeSelector.

◆ configure() [2/2]

virtual void fe::ext::SelectorI::configure ( const sp< RecordGroup > &  rspCriteria,
const sp< FilterI > &  rspFilter,
BWORD  cumulative 
)
inlinevirtual

Configure selection based on a group of criteria.

Each Record in the criteria RecordGroup is applied in the order of iteration.

If cumulative, a test against multiple elements accumulate into a union instead of an intersection.

Reimplemented in fe::ext::ShapeSelector.


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