rtsprofile.component.Component Class Reference

Component object. More...

Inheritance diagram for rtsprofile.component.Component:

Public Member Functions
def	__init__ (self, id='', path_uri='', active_configuration_set='', instance_name='', composite_type=comp_type.NONE, is_required=False, comment='', visible=True, location=Location())
def	__str__ (self)
def	active_configuration_set (self)
def	active_configuration_set (self, active_config_set)
def	comment (self)
def	comment (self, comment)
def	composite_type (self)
def	composite_type (self, composite_type)
def	configuration_sets (self)
def	configuration_sets (self, configuration_sets)
def	data_ports (self)
def	data_ports (self, data_ports)
def	execution_contexts (self)
def	execution_contexts (self, execution_contexts)
def	get_configuration_set_by_id (self, id)
	API functions. More...
def	id (self)
	Properties. More...
def	id (self, id)
def	instance_name (self)
def	instance_name (self, instance_name)
def	is_required (self)
def	is_required (self, is_required)
def	location (self)
def	location (self, location)
def	parse_xml_node (self, node)
	XML. More...
def	parse_yaml (self, y)
	YAML. More...
def	participants (self)
def	participants (self, participants)
def	path_uri (self)
def	path_uri (self, path_uri)
def	properties (self)
def	properties (self, properties)
def	save_xml (self, doc, element)
def	service_ports (self)
def	service_ports (self, service_ports)
def	to_dict (self)
def	visible (self)
def	visible (self, visible)

Public Attributes
	active_configuration_set
	comment
	compositeType
	id
	instance_name
	is_required
	path_uri
	visible

Private Member Functions
def	_reset (self)
	Internal functions. More...

Private Attributes
	_active_config_set
	_comment
	_composite_type
	_config_sets
	_data_ports
	_exec_contexts
	_id
	_instance_name
	_is_required
	_location
	_participants
	_path_uri
	_properties
	_service_ports
	_visible

Detailed Description

Component object.

Information about a component contained in an RT system.

Definition at line 42 of file component.py.

Constructor & Destructor Documentation

def rtsprofile.component.Component.__init__	(		self,
			id = '',
			path_uri = '',
			active_configuration_set = '',
			instance_name = '',
			composite_type = comp_type.NONE,
			is_required = False,
			comment = '',
			visible = True,
			location = Location()
	)

@param id Component ID.
@type id str
@param path_uri Path to the component.
@type path_uri str
@param active_configuration_set Name of the active configuration set.
@type active_configuration_set str
@param instance_name Component's instance name.
@type instance_name str
@param composite_type Type of composition the component is in.
@type composite_type CompositeType
@param is_required If the component is optional in the system.
@type is_required bool
@param comment A comment about the component.
@type comment str
@param visible If this component is visible in graphical displays.
@type visible bool
@param location The location of this component in graphical displays.
@type location Location

Definition at line 48 of file component.py.

Member Function Documentation

def rtsprofile.component.Component.__str__

(

self

)

Definition at line 99 of file component.py.

def rtsprofile.component.Component._reset (   self )

private

Internal functions.

Definition at line 618 of file component.py.

def rtsprofile.component.Component.active_configuration_set

(

self

)

The ID of the active configuration set of the component.

If no configuration set is active, this may be empty.

Definition at line 168 of file component.py.

def rtsprofile.component.Component.active_configuration_set	(		self,
			active_config_set
	)

Definition at line 177 of file component.py.

def rtsprofile.component.Component.comment

(

self

)

Comment about the component.

A brief comment about the component. May or may not be displayed in
other tools. May be empty.

Part of the extended profile.

Definition at line 315 of file component.py.

def rtsprofile.component.Component.comment	(		self,
			comment
	)

Definition at line 327 of file component.py.

def rtsprofile.component.Component.composite_type

(

self

)

The type of composite component this component is involved in.

If this component is involved in a composite component, this attribute
specifies the type of composition. See @ref CompositeType for valid
values.

Definition at line 201 of file component.py.

def rtsprofile.component.Component.composite_type	(		self,
			composite_type
	)

Definition at line 212 of file component.py.

def rtsprofile.component.Component.configuration_sets

(

self

)

The configuration sets in this component.

May be an empty list if this component has no configuration sets.
Members are of type @ref ConfigurationSet.

Definition at line 267 of file component.py.

def rtsprofile.component.Component.configuration_sets	(		self,
			configuration_sets
	)

Definition at line 277 of file component.py.

def rtsprofile.component.Component.data_ports

(

self

)

Data ports owned by this component.

May be an empty list if this component has no data ports. Members are
of type @ref DataPort.

Definition at line 235 of file component.py.

def rtsprofile.component.Component.data_ports	(		self,
			data_ports
	)

Definition at line 245 of file component.py.

def rtsprofile.component.Component.execution_contexts

(

self

)

The execution contexts owned by this component.

May be an empty list if this component does not own any contexts.
Members are of type @ref ExecutionContext.

Definition at line 283 of file component.py.

def rtsprofile.component.Component.execution_contexts	(		self,
			execution_contexts
	)

Definition at line 293 of file component.py.

def rtsprofile.component.Component.get_configuration_set_by_id	(		self,
			id
	)

API functions.

Finds a configuration set in the component by its ID.

@param id The ID of the configuration set to search for.
@return The ConfigurationSet object for the set, or None if it was not
found.

Definition at line 385 of file component.py.

def rtsprofile.component.Component.id

(

self

)

Properties.

ID of this component in the RT system.

In case of the same RT Component specification being used to create
multiple RT Components within a single RT system, this ID is prepended
to the instance name attribute to distinguish individual components.

Definition at line 140 of file component.py.

def rtsprofile.component.Component.id	(		self,
			id
	)

Definition at line 151 of file component.py.

def rtsprofile.component.Component.instance_name

(

self

)

Instance name of the component in the RT system.

In case of the same RT Component specification being used to create
multiple RT Components within a single RT system, this instance name is
appended to the ID attribute to distinguish individual components.

Definition at line 184 of file component.py.

def rtsprofile.component.Component.instance_name	(		self,
			instance_name
	)

Definition at line 195 of file component.py.

def rtsprofile.component.Component.is_required

(

self

)

Specifies if this component is optional in the RT system.

Sometimes a component does not need to be present for an RT system to
function. If this component must be present for the RT system to
function, this attribute will be True.

Definition at line 218 of file component.py.

def rtsprofile.component.Component.is_required	(		self,
			is_required
	)

Definition at line 229 of file component.py.

def rtsprofile.component.Component.location

(

self

)

Specifies the position of the component in graphical tools.

Part of the extended profile.

Definition at line 351 of file component.py.

def rtsprofile.component.Component.location	(		self,
			location
	)

Definition at line 360 of file component.py.

def rtsprofile.component.Component.parse_xml_node	(		self,
			node
	)

XML.

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

Definition at line 401 of file component.py.

def rtsprofile.component.Component.parse_yaml	(		self,
			y
	)

YAML.

Parse a YAML specification of a component into this object.

Definition at line 510 of file component.py.

def rtsprofile.component.Component.participants

(

self

)

The list of participating components, if this component is a
composite component.

Members are of type @ref Participant.

Definition at line 299 of file component.py.

def rtsprofile.component.Component.participants	(		self,
			participants
	)

Definition at line 309 of file component.py.

def rtsprofile.component.Component.path_uri

(

self

)

Path to where this component is registered in URI format.

Definition at line 157 of file component.py.

def rtsprofile.component.Component.path_uri	(		self,
			path_uri
	)

Definition at line 162 of file component.py.

def rtsprofile.component.Component.properties

(

self

)

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 366 of file component.py.

def rtsprofile.component.Component.properties	(		self,
			properties
	)

Definition at line 377 of file component.py.

def rtsprofile.component.Component.save_xml	(		self,
			doc,
			element
	)

Save this component into an xml.dom.Element object.

Definition at line 455 of file component.py.

def rtsprofile.component.Component.service_ports

(

self

)

Service ports owned by this component.

May be an empty list if this component has no service ports. Members
are of type @ref ServicePort.

Definition at line 251 of file component.py.

def rtsprofile.component.Component.service_ports	(		self,
			service_ports
	)

Definition at line 261 of file component.py.

def rtsprofile.component.Component.to_dict

(

self

)

Definition at line 565 of file component.py.

def rtsprofile.component.Component.visible

(

self

)

Display the component in graphical tools.

This value controls whether graphical tools will display this component
or not.

Part of the extended profile.

Definition at line 333 of file component.py.

def rtsprofile.component.Component.visible	(		self,
			visible
	)

Definition at line 345 of file component.py.

Member Data Documentation

rtsprofile.component.Component._active_config_set

private

Definition at line 79 of file component.py.

rtsprofile.component.Component._comment

private

Definition at line 91 of file component.py.

rtsprofile.component.Component._composite_type

private

Definition at line 85 of file component.py.

rtsprofile.component.Component._config_sets

private

Definition at line 280 of file component.py.

rtsprofile.component.Component._data_ports

private

Definition at line 248 of file component.py.

rtsprofile.component.Component._exec_contexts

private

Definition at line 296 of file component.py.

rtsprofile.component.Component._id

private

Definition at line 72 of file component.py.

rtsprofile.component.Component._instance_name

private

Definition at line 82 of file component.py.

rtsprofile.component.Component._is_required

private

Definition at line 88 of file component.py.

rtsprofile.component.Component._location

private

Definition at line 97 of file component.py.

rtsprofile.component.Component._participants

private

Definition at line 312 of file component.py.

rtsprofile.component.Component._path_uri

private

Definition at line 75 of file component.py.

rtsprofile.component.Component._properties

private

Definition at line 380 of file component.py.

rtsprofile.component.Component._service_ports

private

Definition at line 264 of file component.py.

rtsprofile.component.Component._visible

private

Definition at line 94 of file component.py.

rtsprofile.component.Component.active_configuration_set

Definition at line 411 of file component.py.

rtsprofile.component.Component.comment

Definition at line 423 of file component.py.

rtsprofile.component.Component.compositeType

Definition at line 416 of file component.py.

rtsprofile.component.Component.id

Definition at line 408 of file component.py.

rtsprofile.component.Component.instance_name

Definition at line 415 of file component.py.

rtsprofile.component.Component.is_required

Definition at line 420 of file component.py.

rtsprofile.component.Component.path_uri

Definition at line 409 of file component.py.

rtsprofile.component.Component.visible

Definition at line 427 of file component.py.

---

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

• component.py