CellMLToNektar.utilities.Colourable Class Reference

Inheritance diagram for CellMLToNektar.utilities.Colourable:

Public Member Functions
def	__init__ (self, args, kwargs)
def	set_colour (self, colour)
def	get_colour (self)
def	clear_colour (self)

Private Attributes
	_cml_colour

Detailed Description

A mixin class for objects that have a colour attribute, and so support
a depth-first search.

Definition at line 123 of file utilities.py.

Constructor & Destructor Documentation

__init__()

def CellMLToNektar.utilities.Colourable.__init__	(		self,
			args,
			kwargs
	)

Definition at line 128 of file utilities.py.

References CellMLToNektar.utilities.Colourable.clear_colour().

    def __init__(self, *args, **kwargs):
        super(Colourable, self).__init__(*args, **kwargs)
        self.clear_colour()
    

Member Function Documentation

clear_colour()

def CellMLToNektar.utilities.Colourable.clear_colour

(

self

)

Definition at line 138 of file utilities.py.

References CellMLToNektar.utilities.Colourable._cml_colour.

Referenced by CellMLToNektar.utilities.Colourable.__init__().

    def clear_colour(self):
        self._cml_colour = DFS.White

get_colour()

def CellMLToNektar.utilities.Colourable.get_colour

(

self

)

Definition at line 135 of file utilities.py.

References CellMLToNektar.utilities.Colourable._cml_colour.

    def get_colour(self):
        return self._cml_colour
    

set_colour()

def CellMLToNektar.utilities.Colourable.set_colour	(		self,
			colour
	)

Definition at line 132 of file utilities.py.

    def set_colour(self, colour):
        self._cml_colour = colour
    

Member Data Documentation

_cml_colour

CellMLToNektar.utilities.Colourable._cml_colour

private

Definition at line 133 of file utilities.py.

Referenced by CellMLToNektar.utilities.Colourable.clear_colour(), and CellMLToNektar.utilities.Colourable.get_colour().