Public Member Functions | Public Attributes | Private Attributes
rtsprofile.targets.TargetComponent Class Reference

TargetComponent object. More...

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

List of all members.

Public Member Functions

def __init__
def __str__
def component_id
def component_id
def instance_name
def instance_name
def parse_xml_node
def parse_yaml
def properties
def properties
def save_xml
def to_dict

Public Attributes

 component_id
 instance_name

Private Attributes

 _component_id
 _instance_name
 _properties

Detailed Description

TargetComponent object.

Stores enough information to uniquely identify a component in the RT
system. Used to specify target components, for example the components
participating in a group or running in an execution context, or the
execution order of components.

Definition at line 37 of file targets.py.


Constructor & Destructor Documentation

def rtsprofile.targets.TargetComponent.__init__ (   self,
  component_id = '',
  instance_name = '' 
)
Constructor.

@param component_id The ID of the target component.
@type component_id str
@param instance_name The instance name of the target component.
@type instance_name str

Definition at line 45 of file targets.py.


Member Function Documentation

Reimplemented in rtsprofile.targets.TargetExecutionContext, and rtsprofile.targets.TargetPort.

Definition at line 62 of file targets.py.

The ID of the target component.

RT components can be uniquely identified using the component ID and the
instance name.

Definition at line 72 of file targets.py.

def rtsprofile.targets.TargetComponent.component_id (   self,
  component_id 
)

Definition at line 82 of file targets.py.

The instance name of the target component.

RT components can be uniquely identified using the component ID and the
instance name.

Definition at line 88 of file targets.py.

def rtsprofile.targets.TargetComponent.instance_name (   self,
  instance_name 
)

Definition at line 98 of file targets.py.

Parse an xml.dom Node object representing a target component into
this object.

Reimplemented in rtsprofile.targets.TargetExecutionContext, and rtsprofile.targets.TargetPort.

Definition at line 120 of file targets.py.

Parse a YAML specification of a target component into this
object.

Reimplemented in rtsprofile.targets.TargetExecutionContext, and rtsprofile.targets.TargetPort.

Definition at line 132 of file targets.py.

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Reimplemented in rtsprofile.targets.TargetExecutionContext.

Definition at line 104 of file targets.py.

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

Reimplemented in rtsprofile.targets.TargetExecutionContext.

Definition at line 115 of file targets.py.

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

Reimplemented in rtsprofile.targets.TargetExecutionContext, and rtsprofile.targets.TargetPort.

Definition at line 148 of file targets.py.

Save this target component into a dictionary.

Reimplemented in rtsprofile.targets.TargetExecutionContext, and rtsprofile.targets.TargetPort.

Definition at line 160 of file targets.py.


Member Data Documentation

Definition at line 52 of file targets.py.

Definition at line 52 of file targets.py.

Reimplemented in rtsprofile.targets.TargetExecutionContext.

Definition at line 52 of file targets.py.

Definition at line 123 of file targets.py.

Definition at line 123 of file targets.py.


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


rtsprofile
Author(s): Geoffrey Biggs
autogenerated on Sun Mar 26 2017 03:39:43