UpdateSkimFlag Class Reference

Inheritance diagram for UpdateSkimFlag:

Collaboration diagram for UpdateSkimFlag:

Public Member Functions
def	__init__ (self, skim)
def	initialize (self)
def	event (self)

Public Attributes
	skim
	EventExtraInfo

Detailed Description

*[Module for skim expert usage]* Update the skim flag to be 1 if there is at least
one candidate in any of the skim lists.

.. Note::

    Add this module to the post-skim path of each skim in the combined skim, as the
    skim lists are only guaranteed to exist on the conditional path (if a
    conditional path was used).

Definition at line 67 of file flags.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			skim
	)

Initialise module.

Parameters:
    skim (skim.core.BaseSkim): Skim to update event flag for.

Definition at line 79 of file flags.py.

Member Function Documentation

event()

def event

(

self

)

Check if at least one skim list is non-empty; if so, update the skim flag to 1.

Definition at line 100 of file flags.py.

initialize()

def initialize

(

self

)

Check EventExtraInfo has been registered previously. This registration should be
done by InitialiseSkimFlag.

Definition at line 93 of file flags.py.

---

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

• skim/scripts/skim/utils/flags.py