State Class Reference

Public Member Functions
	__init__ (self, name, enter=None, exit=None)
	on_enter (self)
	on_enter (self, callbacks)
	on_exit (self)
	on_exit (self, callbacks)
	__str__ (self)
	__repr__ (self)
	__eq__ (self, other)
	__hash__ (self)

Public Attributes
	name = name
	Name of the State.
	on_enter = enter
	Callback list when entering state.
	on_exit = exit
	Callback list when exiting state.

Protected Member Functions
	_add_callbacks (self, callback, attribute)

Protected Attributes
list	_on_enter = []
	set state as empty list when entering it
list	_on_exit = []
	set state as empty list when exiting it

Detailed Description

Basic State object that can take enter and exit state methods and records
the state of a machine.

You should assign the self.on_enter or self.on_exit attributes to callback functions
or lists of them, if you need them.

Definition at line 41 of file state_machines.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			name,
			enter = None,
			exit = None )

Initialise State with a name and optional lists of callbacks.

Definition at line 50 of file state_machines.py.

    def __init__(self, name, enter=None, exit=None):
        """
        Initialise State with a name and optional lists of callbacks.
        """
        
        self.name = name
        
        self.on_enter = enter
        
        self.on_exit = exit
 

Member Function Documentation

__eq__()

__eq__	(		self,
			other )

Definition at line 130 of file state_machines.py.

    def __eq__(self, other):
        """
        """
        if isinstance(other, str):
            return self.name == other
        else:
            return self.name == other.name
 

__hash__()

__hash__

(

self

)

Definition at line 138 of file state_machines.py.

    def __hash__(self):
        """
        """
        return hash(self.name)
 
 

__repr__()

__repr__

(

self

)

Definition at line 125 of file state_machines.py.

    def __repr__(self):
        """
        """
        return f"State(name={self.name})"
 

__str__()

__str__

(

self

)

Definition at line 120 of file state_machines.py.

    def __str__(self):
        """
        """
        return self.name
 

_add_callbacks()

_add_callbacks ( self, callback, attribute )

protected

Adds callback to a property.

Definition at line 94 of file state_machines.py.

    def _add_callbacks(self, callback, attribute):
        """
        Adds callback to a property.
        """
        if callable(callback):
            attribute.append(callback)
        else:
            B2ERROR(f"Something other than a function (callable) passed into State {self.name}.")
 

on_enter() [1/2]

on_enter

(

self

)

Runs callbacks when a state is entered.

Definition at line 62 of file state_machines.py.

    def on_enter(self):
        """
        Runs callbacks when a state is entered.
        """
        return self._on_enter
 

on_enter() [2/2]

on_enter	(		self,
			callbacks )

Definition at line 69 of file state_machines.py.

    def on_enter(self, callbacks):
        """
        """
        
        self._on_enter = []
        if callbacks:
            self._add_callbacks(callbacks, self._on_enter)
 

on_exit() [1/2]

on_exit

(

self

)

Runs callbacks when a state is exited.

Definition at line 78 of file state_machines.py.

    def on_exit(self):
        """
        Runs callbacks when a state is exited.
        """
        return self._on_exit
 

on_exit() [2/2]

on_exit	(		self,
			callbacks )

Definition at line 85 of file state_machines.py.

    def on_exit(self, callbacks):
        """
        """
        
        self._on_exit = []
        if callbacks:
            self._add_callbacks(callbacks, self._on_exit)
 

Member Data Documentation

_on_enter

_on_enter = []

protected

set state as empty list when entering it

Definition at line 73 of file state_machines.py.

_on_exit

_on_exit = []

protected

set state as empty list when exiting it

Definition at line 89 of file state_machines.py.

name

name = name

Name of the State.

Definition at line 55 of file state_machines.py.

on_enter

on_enter = enter

Callback list when entering state.

Definition at line 57 of file state_machines.py.

on_exit

on_exit = exit

Callback list when exiting state.

Definition at line 59 of file state_machines.py.

---

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

• calibration/scripts/caf/state_machines.py