rtshell.rtinject_comp.StdinWriter Class Reference

From-standard-input writer component for rtinject. More...

Inheritance diagram for rtshell.rtinject_comp.StdinWriter:

List of all members.

Public Member Functions
def	__init__
Private Member Functions
def	_behv
Private Attributes
	_mutex
	_val
	_val_buffer

---

Detailed Description

From-standard-input writer component for rtinject.

Definition at line 46 of file rtinject_comp.py.

---

Constructor & Destructor Documentation

def rtshell.rtinject_comp.StdinWriter.__init__	(		self,
			mgr,
			port_specs,
			event = None,
			max = None,
			args,
			kwargs
	)

Constructor.

@param mgr Reference to the manager that created this component.
@param port_spec The port layout of the component. This must be
         a list of port_types.PortSpec objects.
@param event An event object that can be .set() to indicate
     that the component has finished its assigned task
     and should be shut down.
@param max The maximum number of times this component should
   perform its onExecute function before setting the
   event to request a shutdown. Defaults to -1, for
   unlimited.

Reimplemented from rtshell.gen_comp.GenComp.

Definition at line 47 of file rtinject_comp.py.

---

Member Function Documentation

def rtshell.rtinject_comp.StdinWriter._behv	(		self,
			ec_id
	)		[private]

Behaviour function for derived components.

Deriving classes must implement this function. It will be called by
onExecute. It must return a tuple of (RTC result code, _behv result
value). The RTC result code is used to create the result of onExecute;
if no errors occur, it must be RTC.RTC_OK. The _behv result code is
used to tell the component if the behaviour was able to execute
(whether it succeeded or not), for the purposes of execution counting.
It should be the number of iterations executed.

Reimplemented from rtshell.rtinject_comp.Writer.

Definition at line 57 of file rtinject_comp.py.

---

Member Data Documentation

rtshell::rtinject_comp.StdinWriter::_mutex [private]

Definition at line 47 of file rtinject_comp.py.

rtshell::rtinject_comp.StdinWriter::_val [private]

Reimplemented from rtshell.rtinject_comp.Writer.

Definition at line 57 of file rtinject_comp.py.

rtshell::rtinject_comp.StdinWriter::_val_buffer [private]

Definition at line 47 of file rtinject_comp.py.

---

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

• rtinject_comp.py