rtsprofile.exec_context.ExecutionContext Class Reference

ExecutionContext object. More...

Inheritance diagram for rtsprofile.exec_context.ExecutionContext:

Public Member Functions
def	__init__ (self, id='', kind='', rate=0.0)
def	__str__ (self)
def	id (self)
def	id (self, id)
def	kind (self)
def	kind (self, kind)
def	parse_xml_node (self, node)
def	parse_yaml (self, y)
def	participants (self)
def	participants (self, participants)
def	properties (self)
def	properties (self, properties)
def	rate (self)
def	rate (self, rate)
def	save_xml (self, doc, element)
def	to_dict (self)

Public Attributes
	id
	kind
	rate

Private Attributes
	_id
	_kind
	_participants
	_properties
	_rate

Detailed Description

ExecutionContext object.

Represents an execution context being used in the RT system.

Definition at line 37 of file exec_context.py.

Constructor & Destructor Documentation

def rtsprofile.exec_context.ExecutionContext.__init__	(		self,
			id = '',
			kind = '',
			rate = 0.0
	)

Constructor.

@param id The ID of this execution context.
@type id str
@param kind The action execution type used by this context.
@type kind str
@param rate The execution rate of this context, if it is periodic.
@type float

Definition at line 40 of file exec_context.py.

Member Function Documentation

def rtsprofile.exec_context.ExecutionContext.__str__

(

self

)

Definition at line 63 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.id

(

self

)

The ID used to identify this execution context.

Definition at line 77 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.id	(		self,
			id
	)

Definition at line 82 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.kind

(

self

)

The action execution type used by this context.

Valid values are supposed to be in the specification appendix, but they
aren't. The best way to find them is to create a system with
RTSystemEditor and look at the XML. A common valid value is
PeriodicExecutionContext.

Definition at line 88 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.kind	(		self,
			kind
	)

Definition at line 100 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.parse_xml_node	(		self,
			node
	)

Parse an xml.dom Node object representing an execution context into
this object.

Definition at line 154 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.parse_yaml	(		self,
			y
	)

Parse a YAML spefication of an execution context into this
object.

Definition at line 174 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.participants

(

self

)

The components participating in this execution context.

An ordered list. May be an empty list if no components are
participating in this context.

Definition at line 106 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.participants	(		self,
			participants
	)

Definition at line 116 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.properties

(

self

)

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 138 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.properties	(		self,
			properties
	)

Definition at line 149 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.rate

(

self

)

The execution rate of this context, if it has one, in Hertz.

This value is only used if the execution context is periodic for a data
flow component.

Definition at line 122 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.rate	(		self,
			rate
	)

Definition at line 132 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.save_xml	(		self,
			doc,
			element
	)

Save this execution context into an xml.dom.Element object.

Definition at line 198 of file exec_context.py.

def rtsprofile.exec_context.ExecutionContext.to_dict

(

self

)

Save this execution context into a dictionary.

Definition at line 214 of file exec_context.py.

Member Data Documentation

rtsprofile.exec_context.ExecutionContext._id

private

Definition at line 53 of file exec_context.py.

rtsprofile.exec_context.ExecutionContext._kind

private

Definition at line 56 of file exec_context.py.

rtsprofile.exec_context.ExecutionContext._participants

private

Definition at line 60 of file exec_context.py.

rtsprofile.exec_context.ExecutionContext._properties

private

Definition at line 61 of file exec_context.py.

rtsprofile.exec_context.ExecutionContext._rate

private

Definition at line 59 of file exec_context.py.

rtsprofile.exec_context.ExecutionContext.id

Definition at line 159 of file exec_context.py.

rtsprofile.exec_context.ExecutionContext.kind

Definition at line 160 of file exec_context.py.

rtsprofile.exec_context.ExecutionContext.rate

Definition at line 162 of file exec_context.py.

---

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

• exec_context.py