rtshell.actions.CheckForPortAct Class Reference

Check if a port exists on a component. More...

Inheritance diagram for rtshell.actions.CheckForPortAct:

List of all members.

Public Member Functions
def	__init__
def	__str__
Private Member Functions
def	_execute
Private Attributes
	_path
	_path_str
	_port_name

---

Detailed Description

Check if a port exists on a component.

Check for a port on a 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 has the desired port. If the port is not present on the
component, it will fail. Otherwise, it will succeed. No check is performed
to ensure that the correct component is at that path; for that, use the
@ref CheckForRequiredCompAct action.

This action will not fail if the specified component does not exist or is
incorrect. To cause an abort in these situations, use @ref
CheckForRequiredCompAct.

Definition at line 202 of file actions.py.

---

Constructor & Destructor Documentation

def rtshell.actions.CheckForPortAct.__init__	(		self,
			path_str,
			port_name,
			callbacks = []
	)

Definition at line 217 of file actions.py.

---

Member Function Documentation

def rtshell.actions.CheckForPortAct.__str__

(

self

)

Reimplemented from rtshell.actions.Action.

Definition at line 223 of file actions.py.

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

---

Member Data Documentation

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

Definition at line 217 of file actions.py.

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

Definition at line 217 of file actions.py.

rtshell::actions.CheckForPortAct::_port_name [private]

Definition at line 217 of file actions.py.

---

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

• actions.py