CellMLToNektar.utilities.Sentinel Class Reference

Inheritance diagram for CellMLToNektar.utilities.Sentinel:

Collaboration diagram for CellMLToNektar.utilities.Sentinel:

Public Member Functions
def	__init__
def	__nonzero__
def	set

Private Attributes
	_tf

Detailed Description

A simple true/false store that can be used as a default parameter value in recursive calls.

This provides a slightly nicer looking alternative to code such as:

def f(done=[False]):
   if not done[0]:
       # do some stuff
       if xyz: done[0] = True
       f(done)

The list can be replaced with a Sentinel instance.

Definition at line 142 of file utilities.py.

Constructor & Destructor Documentation

def CellMLToNektar.utilities.Sentinel.__init__	(		self,
			tf = False
	)

Create a new, unset sentinel.

Definition at line 155 of file utilities.py.

    def __init__(self, tf=False):
        """Create a new, unset sentinel."""
        self._tf = tf