Public Member Functions | Public Attributes | Private Attributes | List of all members
rtsprofile.targets.TargetExecutionContext Class Reference

TargetExecutionContext object. More...

Inheritance diagram for rtsprofile.targets.TargetExecutionContext:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, component_id='', instance_name='', id='')
 
def __str__ (self)
 
def id (self)
 
def id (self, id)
 
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 to_dict (self)
 
- Public Member Functions inherited from rtsprofile.targets.TargetComponent
def __init__ (self, component_id='', instance_name='')
 
def __str__ (self)
 
def component_id (self)
 
def component_id (self, component_id)
 
def instance_name (self)
 
def instance_name (self, instance_name)
 
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 to_dict (self)
 

Public Attributes

 id
 
- Public Attributes inherited from rtsprofile.targets.TargetComponent
 component_id
 
 instance_name
 

Private Attributes

 _id
 
 _properties
 

Detailed Description

TargetExecutionContext object.

Stores enough information to uniquely identify an execution context in
the RT system. Used to specify target execution contexts of components that
are used to manage execution order, execution conditions, and so on. An
RT component may hold multiple execution contexts. The execution context
concerned must be specified when activating, shutting down, etc an RT
component.

Definition at line 241 of file targets.py.

Constructor & Destructor Documentation

def rtsprofile.targets.TargetExecutionContext.__init__ (   self,
  component_id = '',
  instance_name = '',
  id = '' 
)
Constructor. See also the @ref TargetComponent constructor.

@param id The ID of the target execution context.
@type id str

Definition at line 251 of file targets.py.

Member Function Documentation

def rtsprofile.targets.TargetExecutionContext.__str__ (   self)

Definition at line 265 of file targets.py.

def rtsprofile.targets.TargetExecutionContext.id (   self)
The ID of the target execution context.

Definition at line 274 of file targets.py.

def rtsprofile.targets.TargetExecutionContext.id (   self,
  id 
)

Definition at line 279 of file targets.py.

def rtsprofile.targets.TargetExecutionContext.parse_xml_node (   self,
  node 
)
Parse an xml.dom Node object representing a target execution context
into this object.

Definition at line 302 of file targets.py.

def rtsprofile.targets.TargetExecutionContext.parse_yaml (   self,
  y 
)
Parse a YAML specification of a target execution context into this
object.

Definition at line 314 of file targets.py.

def rtsprofile.targets.TargetExecutionContext.properties (   self)
Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 285 of file targets.py.

def rtsprofile.targets.TargetExecutionContext.properties (   self,
  properties 
)

Definition at line 296 of file targets.py.

def rtsprofile.targets.TargetExecutionContext.save_xml (   self,
  doc,
  element 
)
Save this target execution context into an xml.dom.Element
object.

Definition at line 326 of file targets.py.

def rtsprofile.targets.TargetExecutionContext.to_dict (   self)
Save this target execution context into a dictionary.

Definition at line 334 of file targets.py.

Member Data Documentation

rtsprofile.targets.TargetExecutionContext._id
private

Definition at line 262 of file targets.py.

rtsprofile.targets.TargetExecutionContext._properties
private

Definition at line 263 of file targets.py.

rtsprofile.targets.TargetExecutionContext.id

Definition at line 309 of file targets.py.


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


rtsprofile
Author(s): Geoffrey Biggs
autogenerated on Fri Jun 7 2019 21:52:35