Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
rtsprofile.component.Component Class Reference

Component object. More...

List of all members.

Public Member Functions

def __init__
def __str__
def active_configuration_set
def active_configuration_set
def comment
def comment
def composite_type
def composite_type
def configuration_sets
def configuration_sets
def data_ports
def data_ports
def execution_contexts
def execution_contexts
def get_configuration_set_by_id
 API functions.
def id
 Properties.
def id
def instance_name
def instance_name
def is_required
def is_required
def location
def location
def parse_xml_node
 XML.
def parse_yaml
 YAML.
def participants
def participants
def path_uri
def path_uri
def properties
def properties
def save_xml
def service_ports
def service_ports
def to_dict
def visible
def visible

Public Attributes

 active_configuration_set
 comment
 compositeType
 id
 instance_name
 is_required
 path_uri
 visible

Private Member Functions

def _reset
 Internal functions.

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 45 of file component.py.


Member Function Documentation

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

XML.

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

Definition at line 401 of file component.py.

YAML.

Parse a YAML specification of a component into this object.

Definition at line 510 of file component.py.

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.

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.

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.

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.

Definition at line 565 of file component.py.

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

Definition at line 64 of file component.py.

Definition at line 64 of file component.py.

Definition at line 64 of file component.py.

Definition at line 277 of file component.py.

Definition at line 245 of file component.py.

Definition at line 293 of file component.py.

Definition at line 64 of file component.py.

Definition at line 64 of file component.py.

Definition at line 64 of file component.py.

Definition at line 64 of file component.py.

Definition at line 309 of file component.py.

Definition at line 64 of file component.py.

Definition at line 377 of file component.py.

Definition at line 261 of file component.py.

Definition at line 64 of file component.py.

Definition at line 404 of file component.py.

Definition at line 404 of file component.py.

Definition at line 404 of file component.py.

Definition at line 404 of file component.py.

Definition at line 404 of file component.py.

Definition at line 404 of file component.py.

Definition at line 404 of file component.py.

Definition at line 404 of file component.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