rtshell.actions.CheckForConnAct Class Reference

Check if a connection between two components exists and is correct. More...

Inheritance diagram for rtshell.actions.CheckForConnAct:

List of all members.

Public Member Functions
def	__init__
def	__str__
Private Member Functions
def	_execute
Private Attributes
	_d_path
	_dest
	_id
	_props
	_s_path
	_source

---

Detailed Description

Check if a connection between two components exists and is correct.

Check for a correct connection between two components.

This action checks if there is a connection between the specified source
and destination ports. If there is, it will check that any given properties
are also correct.

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 420 of file actions.py.

---

Constructor & Destructor Documentation

def rtshell.actions.CheckForConnAct.__init__	(		self,
			source,
			dest,
			id,
			props = {},
			callbacks = []
	)

Definition at line 435 of file actions.py.

---

Member Function Documentation

def rtshell.actions.CheckForConnAct.__str__

(

self

)

Reimplemented from rtshell.actions.Action.

Definition at line 444 of file actions.py.

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

---

Member Data Documentation

rtshell::actions.CheckForConnAct::_d_path [private]

Definition at line 435 of file actions.py.

rtshell::actions.CheckForConnAct::_dest [private]

Definition at line 435 of file actions.py.

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

Definition at line 435 of file actions.py.

rtshell::actions.CheckForConnAct::_props [private]

Definition at line 435 of file actions.py.

rtshell::actions.CheckForConnAct::_s_path [private]

Definition at line 435 of file actions.py.

rtshell::actions.CheckForConnAct::_source [private]

Definition at line 435 of file actions.py.

---

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

• actions.py