rtshell.actions.CheckForRequiredCompAct Class Reference

Check if a required component is present. More...

Inheritance diagram for rtshell.actions.CheckForRequiredCompAct:

List of all members.

Public Member Functions
def	__init__
def	__str__
Private Member Functions
def	_execute
Private Attributes
	_id
	_instance_name
	_path
	_path_str

---

Detailed Description

Check if a required component is present.

Check for a required component in the RTC Tree.

This action checks the rtctree to see if a component is present at a
particular path. If it finds a component at that path, it will check that
the component's ID and instance name to ensure it is the desired component.
If the component is not present or is the wrong component, this action will
fail. Otherwise, it will succeed.

Definition at line 152 of file actions.py.

---

Constructor & Destructor Documentation

def rtshell.actions.CheckForRequiredCompAct.__init__	(		self,
			path_str,
			id,
			instance_name,
			callbacks = []
	)

Definition at line 162 of file actions.py.

---

Member Function Documentation

def rtshell.actions.CheckForRequiredCompAct.__str__

(

self

)

Reimplemented from rtshell.actions.Action.

Definition at line 169 of file actions.py.

def rtshell.actions.CheckForRequiredCompAct._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 174 of file actions.py.

---

Member Data Documentation

rtshell::actions.CheckForRequiredCompAct::_id [private]

Definition at line 162 of file actions.py.

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

Definition at line 162 of file actions.py.

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

Definition at line 162 of file actions.py.

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

Definition at line 162 of file actions.py.

---

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

• actions.py