rtsprofile.message_sending.WaitTime Class Reference

WaitTime object. More...

Inheritance diagram for rtsprofile.message_sending.WaitTime:

Public Member Functions
def	__init__ (self, wait_time=0, sequence=0, target_component=TargetExecutionContext())
def	__str__ (self)
def	parse_xml_node (self, node)
def	parse_yaml (self, y)
def	save_xml (self, doc, element)
def	to_dict (self)
def	wait_time (self)
def	wait_time (self, wait_time)
Public Member Functions inherited from rtsprofile.message_sending.Condition
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
	wait_time
Public Attributes inherited from rtsprofile.message_sending.Condition
	sequence
	target_component

Private Attributes
	_wait_time

Detailed Description

WaitTime object.

Specifies the time to wait before executing the specified action on the
target RT component. After the action command is received by the RT
component, it will wait the specified length of time before executing it.

Definition at line 511 of file message_sending.py.

Constructor & Destructor Documentation

def rtsprofile.message_sending.WaitTime.__init__	(		self,
			wait_time = 0,
			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
@param wait_time The length of time to wait, in milliseconds.
@type wait_time int

Definition at line 519 of file message_sending.py.

Member Function Documentation

def rtsprofile.message_sending.WaitTime.__str__

(

self

)

Definition at line 535 of file message_sending.py.

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

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

Definition at line 554 of file message_sending.py.

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

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

Definition at line 567 of file message_sending.py.

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

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

Definition at line 576 of file message_sending.py.

def rtsprofile.message_sending.WaitTime.to_dict

(

self

)

Save this wait_time condition into a dictionary.

Definition at line 584 of file message_sending.py.

def rtsprofile.message_sending.WaitTime.wait_time

(

self

)

The length of time to wait before executing the specified action.

In milliseconds.

Definition at line 540 of file message_sending.py.

def rtsprofile.message_sending.WaitTime.wait_time	(		self,
			wait_time
	)

Definition at line 549 of file message_sending.py.

Member Data Documentation

rtsprofile.message_sending.WaitTime._wait_time

private

Definition at line 533 of file message_sending.py.

rtsprofile.message_sending.WaitTime.wait_time

Definition at line 563 of file message_sending.py.

---

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

• message_sending.py