rtshell.actions.StateChangeAct Class Reference

State change base action. More...

Inheritance diagram for rtshell.actions.StateChangeAct:

List of all members.

Public Member Functions
def	__init__
def	__str__
def	comp_id
def	ec_id
def	instance_name
def	path
Private Member Functions
def	_execute
Private Attributes
	_comp_id
	_ec_id
	_instance_name
	_path
	_path_str

---

Detailed Description

State change base action.

Base action for actions that change a component's state.

Actions that inherit from this should provide three members:
- self._action_str: A string describing the action for use in str(). e.g.
  "Activate".
- self._verbose_str: A similar string for use in the verbose output. e.g.
  "Activating".
- self._action_impl: A function to be called by self._execute to perform
  the action. It will be passed two arguments; the first is the component
  node from rtctree, the second is the index of the execution context
  involved. This should return (True, None) or False and an error string.

Definition at line 653 of file actions.py.

---

Constructor & Destructor Documentation

def rtshell.actions.StateChangeAct.__init__	(		self,
			path_str,
			comp_id,
			instance_name,
			ec_id,
			callbacks = []
	)

Reimplemented in rtshell.actions.ResetCompAct, rtshell.actions.DeactivateCompAct, and rtshell.actions.ActivateCompAct.

Definition at line 667 of file actions.py.

---

Member Function Documentation

def rtshell.actions.StateChangeAct.__str__

(

self

)

Reimplemented from rtshell.actions.Action.

Definition at line 675 of file actions.py.

def rtshell.actions.StateChangeAct._execute	(		self,
			rtctree
	)		[private]

Base for action execution method.

Return (True, '') or (False, 'Why I failed.') when implementing this
method.

Reimplemented from rtshell.actions.Action.

Definition at line 699 of file actions.py.

def rtshell.actions.StateChangeAct.comp_id

(

self

)

Identification string of the component.

Definition at line 680 of file actions.py.

def rtshell.actions.StateChangeAct.ec_id

(

self

)

Target execution context ID.

Definition at line 685 of file actions.py.

def rtshell.actions.StateChangeAct.instance_name

(

self

)

Instance name of the target component.

Definition at line 690 of file actions.py.

def rtshell.actions.StateChangeAct.path

(

self

)

Full path of the target component.

Definition at line 695 of file actions.py.

---

Member Data Documentation

rtshell::actions.StateChangeAct::_comp_id [private]

Definition at line 667 of file actions.py.

rtshell::actions.StateChangeAct::_ec_id [private]

Definition at line 667 of file actions.py.

rtshell::actions.StateChangeAct::_instance_name [private]

Definition at line 667 of file actions.py.

rtshell::actions.StateChangeAct::_path [private]

Definition at line 667 of file actions.py.

rtshell::actions.StateChangeAct::_path_str [private]

Definition at line 667 of file actions.py.

---

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

• actions.py