rtshell.actions.SetConfigParamValueAct Class Reference

Set a configuration parameter in a configuration set. More...

Inheritance diagram for rtshell.actions.SetConfigParamValueAct:

List of all members.

Public Member Functions
def	__init__
def	__str__
Private Member Functions
def	_execute
Private Attributes
	_new_value
	_param
	_path
	_path_str
	_set

---

Detailed Description

Set a configuration parameter in a configuration set.

Change the value of a configuration parameter in a set.

This action sets the value of the given configuration parameter in the
given configuration set. It will fail if the set does not exist, or the
parameter does not exist in that set.

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

---

Constructor & Destructor Documentation

def rtshell.actions.SetConfigParamValueAct.__init__	(		self,
			path_str,
			set,
			parameter,
			new_value,
			callbacks = []
	)

Definition at line 384 of file actions.py.

---

Member Function Documentation

def rtshell.actions.SetConfigParamValueAct.__str__

(

self

)

Reimplemented from rtshell.actions.Action.

Definition at line 392 of file actions.py.

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

---

Member Data Documentation

rtshell::actions.SetConfigParamValueAct::_new_value [private]

Definition at line 384 of file actions.py.

rtshell::actions.SetConfigParamValueAct::_param [private]

Definition at line 384 of file actions.py.

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

Definition at line 384 of file actions.py.

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

Definition at line 384 of file actions.py.

rtshell::actions.SetConfigParamValueAct::_set [private]

Definition at line 384 of file actions.py.

---

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

• actions.py