rtsprofile.message_sending.Preceding Class Reference

Preceding object. More...

Inheritance diagram for rtsprofile.message_sending.Preceding:

List of all members.

Public Member Functions
def	__init__
def	__str__
def	parse_xml_node
def	parse_yaml
def	preceding_components
def	preceding_components
def	save_xml
def	sending_timing
def	sending_timing
def	timeout
def	timeout
def	to_dict
Public Attributes
	sending_timing
	timeout
Private Attributes
	_preceding_components
	_sending_timing
	_timeout

---

Detailed Description

Preceding object.

Specifies that the target RT component should precede other RT
components that are part of the same action (e.g. activation) when that
action is executed.

Definition at line 341 of file message_sending.py.

---

Constructor & Destructor Documentation

def rtsprofile.message_sending.Preceding.__init__	(		self,
			sequence = 0,
			target_component = TargetExecutionContext(),
			timeout = 0,
			sending_timing = '',
			preceding_components = []
	)

Constructor.

@param sequence Execution order of the target component.
@type sequence int
@param target_component The target of the condition.
@type target_component TargetComponent
@param timeout Status check timeout.
@type timeout int
@param sending_timing Timing for executing actions.
@type sending_timing str
@param preceding_components Preceding components of the condition.
@type preceding components list(TargetExecutionContext)

Definition at line 348 of file message_sending.py.

---

Member Function Documentation

def rtsprofile.message_sending.Preceding.__str__

(

self

)

Reimplemented from rtsprofile.message_sending.Condition.

Definition at line 376 of file message_sending.py.

def rtsprofile.message_sending.Preceding.parse_xml_node	(		self,
			node
	)

Parse an xml.dom Node object representing a preceding condition into
this object.

Reimplemented from rtsprofile.message_sending.Condition.

Definition at line 430 of file message_sending.py.

def rtsprofile.message_sending.Preceding.parse_yaml	(		self,
			y
	)

Parse a YAML specification of a preceding condition into this
object.

Reimplemented from rtsprofile.message_sending.Condition.

Definition at line 453 of file message_sending.py.

def rtsprofile.message_sending.Preceding.preceding_components

(

self

)

Preceding components of this condition.

Definition at line 420 of file message_sending.py.

def rtsprofile.message_sending.Preceding.preceding_components	(		self,
			preceding_components
	)

Definition at line 425 of file message_sending.py.

def rtsprofile.message_sending.Preceding.save_xml	(		self,
			doc,
			element
	)

Save this preceding condition into an xml.dom.Element object.

Reimplemented from rtsprofile.message_sending.Condition.

Definition at line 474 of file message_sending.py.

def rtsprofile.message_sending.Preceding.sending_timing

(

self

)

Timing for executing actions.

Either wait for the preceding RT component to finish executing the
action (specified by "SYNC"), or execute the action without waiting for
the preceding RT component to finish (specified by "ASYNC"). When not
specified, the first option will be assumed.

Definition at line 402 of file message_sending.py.

def rtsprofile.message_sending.Preceding.sending_timing	(		self,
			sending_timing
	)

Definition at line 414 of file message_sending.py.

def rtsprofile.message_sending.Preceding.timeout

(

self

)

Time out for checking if the target component has executed the
action successfully.

Can be zero. Specified in milliseconds.

Definition at line 386 of file message_sending.py.

def rtsprofile.message_sending.Preceding.timeout	(		self,
			timeout
	)

Definition at line 396 of file message_sending.py.

def rtsprofile.message_sending.Preceding.to_dict

(

self

)

Save this preceding condition into a dictionary.

Reimplemented from rtsprofile.message_sending.Condition.

Definition at line 491 of file message_sending.py.

---

Member Data Documentation

rtsprofile::message_sending.Preceding::_preceding_components [private]

Definition at line 361 of file message_sending.py.

rtsprofile::message_sending.Preceding::_sending_timing [private]

Definition at line 361 of file message_sending.py.

rtsprofile::message_sending.Preceding::_timeout [private]

Definition at line 361 of file message_sending.py.

rtsprofile::message_sending.Preceding::sending_timing

Definition at line 433 of file message_sending.py.

rtsprofile::message_sending.Preceding::timeout

Definition at line 433 of file message_sending.py.

---

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

• message_sending.py