rtsprofile.message_sending.Condition Class Reference

Condition base object. More...

Inheritance diagram for rtsprofile.message_sending.Condition:

Public Member Functions
def	__init__ (self, sequence=0, target_component=TargetExecutionContext())
def	__str__ (self)
def	parse_xml_node (self, node)
def	parse_yaml (self, y)
def	properties (self)
def	properties (self, properties)
def	save_xml (self, doc, element)
def	sequence (self)
def	sequence (self, sequence)
def	target_component (self)
def	target_component (self, target_component)
def	to_dict (self)

Public Attributes
	sequence
	target_component

Private Attributes
	_properties
	_sequence
	_target_component

Detailed Description

Condition base object.

Specifies execution orderings and conditions for RT components in the RT
system.

Execution conditions can include the time to wait before executing and
order of precedence for components. The involved RT component is specified
using @ref TargetExecutionContext.

Definition at line 201 of file message_sending.py.

Constructor & Destructor Documentation

def rtsprofile.message_sending.Condition.__init__	(		self,
			sequence = 0,
			target_component = TargetExecutionContext()
	)

Constructor.

@param sequence Execution order of the target component.
@type sequence int
@param target_component The target of the condition.
@type target_component TargetComponent

Definition at line 211 of file message_sending.py.

Member Function Documentation

def rtsprofile.message_sending.Condition.__str__

(

self

)

Definition at line 228 of file message_sending.py.

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

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

Definition at line 280 of file message_sending.py.

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

Parse a YAML specification of a condition into this object.

Definition at line 296 of file message_sending.py.

def rtsprofile.message_sending.Condition.properties

(

self

)

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 264 of file message_sending.py.

def rtsprofile.message_sending.Condition.properties	(		self,
			properties
	)

Definition at line 275 of file message_sending.py.

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

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

Definition at line 310 of file message_sending.py.

def rtsprofile.message_sending.Condition.sequence

(

self

)

The execution order of the target components for the various
actions.

Definition at line 238 of file message_sending.py.

def rtsprofile.message_sending.Condition.sequence	(		self,
			sequence
	)

Definition at line 246 of file message_sending.py.

def rtsprofile.message_sending.Condition.target_component

(

self

)

Target component of the condition.

Definition at line 252 of file message_sending.py.

def rtsprofile.message_sending.Condition.target_component	(		self,
			target_component
	)

Definition at line 257 of file message_sending.py.

def rtsprofile.message_sending.Condition.to_dict

(

self

)

Save this condition into a dictionary.

Definition at line 323 of file message_sending.py.

Member Data Documentation

rtsprofile.message_sending.Condition._properties

private

Definition at line 226 of file message_sending.py.

rtsprofile.message_sending.Condition._sequence

private

Definition at line 221 of file message_sending.py.

rtsprofile.message_sending.Condition._target_component

private

Definition at line 225 of file message_sending.py.

rtsprofile.message_sending.Condition.sequence

Definition at line 285 of file message_sending.py.

rtsprofile.message_sending.Condition.target_component

Definition at line 289 of file message_sending.py.

---

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

• message_sending.py