Inheritance diagram for flexbe_states.log_key_state.LogKeyState:

Public Member Functions
def	__init__ (self, text, severity=Logger.REPORT_HINT)

def	execute (self, userdata)

def	on_enter (self, userdata)

Private Attributes
	_severity

	_text

Detailed Description

A state that can log a predefined message including an input key
to precisely inform the operator about what happened to the behavior.

-- text             string          The message to be logged to the terminal Example:  'Counter value:  {}'.
-- severity     uint8       Type of logging (Logger.REPORT_INFO / WARN / HINT / ERROR)

#> data             object              The data provided to be printed in the message. The exact type depends on the request.

<= done                                 Indicates that the message has been logged.

Definition at line 5 of file log_key_state.py.

Constructor & Destructor Documentation

◆ init()

def flexbe_states.log_key_state.LogKeyState.__init__	(	self,
		text,
		severity = `Logger.REPORT_HINT`
	)

Definition at line 18 of file log_key_state.py.

Member Function Documentation

◆ execute()

def flexbe_states.log_key_state.LogKeyState.execute	(	self,
		userdata
	)

Definition at line 24 of file log_key_state.py.

◆ on_enter()

def flexbe_states.log_key_state.LogKeyState.on_enter	(	self,
		userdata
	)

Log upon entering the state.

Definition at line 28 of file log_key_state.py.

Member Data Documentation

◆ _severity

flexbe_states.log_key_state.LogKeyState._severity

private

Definition at line 22 of file log_key_state.py.

◆ _text

flexbe_states.log_key_state.LogKeyState._text

private

Definition at line 21 of file log_key_state.py.

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

log_key_state.py

Public Member Functions

Private Attributes