SelectRefiner Class Reference

Inheritance diagram for SelectRefiner:

Public Member Functions
	__init__ (self, wrapped_refiner, select=None, exclude=None)
	refine (self, harvesting_module, crops, *args, **kwds)
	__get__ (self, harvesting_module, cls=None)
	__call__ (self, harvesting_module, crops=None, *args, **kwds)

Public Attributes
	wrapped_refiner = wrapped_refiner
	cached value of the wrapped refiner
	select = select
	cached value of the selector
	exclude = exclude
	cached value of the exclusion flag
	refiner_function = refiner_function
	cached copy of the instance's refiner function

Detailed Description

Refiner for selection

Definition at line 917 of file refiners.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			wrapped_refiner,
			select = None,
			exclude = None )

Constructor for this refiner

Definition at line 920 of file refiners.py.

    def __init__(self, wrapped_refiner, select=None, exclude=None):
        """Constructor for this refiner"""
        if select is None:
            select = []
        if exclude is None:
            exclude = []
        ## cached value of the wrapped refiner
        self.wrapped_refiner = wrapped_refiner
        ## cached value of the selector
        self.select = select
        ## cached value of the exclusion flag
        self.exclude = exclude
 

Member Function Documentation

__call__()

__call__ ( self, harvesting_module, crops = None, * args, ** kwds )

inherited

implementation of the function-call of the Refiner instance
     r = Refiner()
     r(harvester) # decoration
     r(harvester, crops, args, keywords) # refinement

Definition at line 55 of file refiners.py.

    def __call__(self, harvesting_module, crops=None, *args, **kwds):
        """implementation of the function-call of the Refiner instance
             r = Refiner()
             r(harvester) # decoration
             r(harvester, crops, args, keywords) # refinement
        """
        if crops is None:
            # Decoration mode
            harvesting_module.refiners.append(self)
            return harvesting_module
        else:
            # Refining mode
            return self.refine(harvesting_module, crops, *args, **kwds)
 

__get__()

__get__ ( self, harvesting_module, cls = None )

inherited

Getter of the Refiner instance

Definition at line 42 of file refiners.py.

    def __get__(self, harvesting_module, cls=None):
        """Getter of the Refiner instance"""
        if harvesting_module is None:
            # Class access
            return self
        else:
            # Instance access
            refine = self.refine
 
            def bound_call(*args, **kwds):
                return refine(harvesting_module, *args, **kwds)
            return bound_call
 

refine()

refine	(		self,
			harvesting_module,
			crops,
		*	args,
		**	kwds )

Process this selection

Reimplemented from Refiner.

Definition at line 933 of file refiners.py.

    def refine(self, harvesting_module, crops, *args, **kwds):
        """Process this selection"""
        selected_crops = select_crop_parts(crops, select=self.select, exclude=self.exclude)
        self.wrapped_refiner(harvesting_module, selected_crops, *args, **kwds)
 
 

Member Data Documentation

exclude

exclude = exclude

cached value of the exclusion flag

Definition at line 931 of file refiners.py.

refiner_function

refiner_function = refiner_function

inherited

cached copy of the instance's refiner function

Definition at line 40 of file refiners.py.

select

select = select

cached value of the selector

Definition at line 929 of file refiners.py.

wrapped_refiner

wrapped_refiner = wrapped_refiner

cached value of the wrapped refiner

Definition at line 927 of file refiners.py.

---

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

• tracking/scripts/tracking/harvest/refiners.py