rtsprofile.targets.TargetComponent Class Reference

TargetComponent object. More...

Inheritance diagram for rtsprofile.targets.TargetComponent:

Public Member Functions
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
	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

def rtsprofile.targets.TargetComponent.__str__

(

self

)

Definition at line 62 of file targets.py.

def rtsprofile.targets.TargetComponent.component_id

(

self

)

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.

def rtsprofile.targets.TargetComponent.instance_name

(

self

)

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.

def rtsprofile.targets.TargetComponent.parse_xml_node	(		self,
			node
	)

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

Definition at line 120 of file targets.py.

def rtsprofile.targets.TargetComponent.parse_yaml	(		self,
			y
	)

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

Definition at line 132 of file targets.py.

def rtsprofile.targets.TargetComponent.properties

(

self

)

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 104 of file targets.py.

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

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.

Definition at line 148 of file targets.py.

def rtsprofile.targets.TargetComponent.to_dict

(

self

)

Save this target component into a dictionary.

Definition at line 160 of file targets.py.

Member Data Documentation

rtsprofile.targets.TargetComponent._component_id

private

Definition at line 56 of file targets.py.

rtsprofile.targets.TargetComponent._instance_name

private

Definition at line 59 of file targets.py.

rtsprofile.targets.TargetComponent._properties

private

Definition at line 60 of file targets.py.

rtsprofile.targets.TargetComponent.component_id

Definition at line 125 of file targets.py.

rtsprofile.targets.TargetComponent.instance_name

Definition at line 126 of file targets.py.

---

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

• targets.py