RtsProfile object. More...

Public Member Functions
def	__init__
def	__str__
def	abstract
def	abstract
def	activation
def	activation
def	comment
def	comment
def	components
def	components
def	creation_date
def	creation_date
def	data_port_connectors
def	data_port_connectors
def	deactivation
def	deactivation
def	finalizing
def	finalizing
def	find_comp_by_target
	API functions.
def	groups
def	groups
def	id
	Properties.
def	id
def	initializing
def	initializing
def	optional_data_connections
def	optional_service_connections
def	parse_from_xml
	XML.
def	parse_from_yaml
	YAML.
def	properties
def	properties
def	required_data_connections
def	required_service_connections
def	resetting
def	resetting
def	save_to_xml
def	save_to_yaml
def	service_port_connectors
def	service_port_connectors
def	shutdown
def	shutdown
def	startup
def	startup
def	update_date
def	update_date
def	version
def	version
def	version_up_log
def	version_up_log
Public Attributes
	abstract
	comment
	creation_date
	id
	update_date
	version
Private Member Functions
def	_parse_xml
	Internal functions.
def	_parse_yaml
def	_reset
def	_to_dict
def	_to_xml_dom
def	_to_yaml
Private Attributes
	_abstract
	_activation
	_comment
	_components
	_creation_date
	_data_port_connectors
	_deactivation
	_finalizing
	_groups
	_id
	_initializing
	_properties
	_resetting
	_service_port_connectors
	_shutdown
	_startup
	_update_date
	_version
	_version_up_log

Detailed Description

RtsProfile object.

Definition at line 50 of file rts_profile.py.

Constructor & Destructor Documentation

def rtsprofile.rts_profile.RtsProfile.__init__	(	self,
		xml_spec = `None`,
		yaml_spec = `None`
	)

Constructor.

Pass in an RTSProfile specification either in a string or a file
object, and the RtsProfile will be loaded from that.

If no specification is provided, the RtsProfile will be constructed
from the default values. Use the properties to set the values you need.

@param xml_spec A string or open file object containing the XML
specification of the RTS Profile. If present, the other arguments must
be None.

@param yaml_spec A string or open file object containing the YAML
specification of the RTS Profile. If present, the other arguments must
be None.

Definition at line 51 of file rts_profile.py.

Member Function Documentation

def rtsprofile.rts_profile.RtsProfile.__str__ ( self )

Definition at line 82 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile._parse_xml	(	self,
		dom
	)	`[private]`

Internal functions.

Definition at line 513 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile._parse_yaml	(	self,
		spec
	)	`[private]`

Definition at line 579 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile._reset ( self ) [private]

Definition at line 635 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile._to_dict ( self ) [private]

Definition at line 661 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile._to_xml_dom ( self ) [private]

Definition at line 726 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile._to_yaml ( self ) [private]

Definition at line 808 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.abstract ( self )

Description of this RT system.

May be empty.

Definition at line 149 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.abstract	(	self,
		abstract
	)

Definition at line 158 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.activation ( self )

Ordering and conditions for when the RT system is activated.

Definition at line 291 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.activation	(	self,
		activation
	)

Definition at line 296 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.comment ( self )

Comment about the system.

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

Part of the extended profile.

Definition at line 346 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.comment	(	self,
		comment
	)

Definition at line 358 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.components ( self )

Information about the components that make up the RT system.

May be an empty list if there are no components. Members are of type
@ref Component.

Definition at line 205 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.components	(	self,
		components
	)

Definition at line 215 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.creation_date ( self )

The date this RT system was first created.

Usually set automatically by the tool that created the system.

Definition at line 164 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.creation_date	(	self,
		creation_date
	)

Definition at line 173 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.data_port_connectors ( self )

Connections between data ports in the RT system.

Members are of type @ref DataPortConnector.

Definition at line 237 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.data_port_connectors	(	self,
		data_port_connectors
	)

Definition at line 246 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.deactivation ( self )

Ordering and conditions for when the RT system is deactivated.

Definition at line 302 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.deactivation	(	self,
		deactivation
	)

Definition at line 307 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.finalizing ( self )

Ordering and conditions for when the RT system is finalised.

Definition at line 335 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.finalizing	(	self,
		finalizing
	)

Definition at line 340 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.find_comp_by_target	(	self,
		target
	)

API functions.

Finds a component using a TargetComponent or one of its subclasses.

@param A @ref TargetComponent object or subclass of @ref
TargetComponent.
@return A Component object matching the target.
@raises MissingComponentError

Definition at line 401 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.groups ( self )

Information about the component groups in the RT system.

May be an empty list if there are no groups. Members are of type @ref
ComponentGroup.

Definition at line 221 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.groups	(	self,
		groups
	)

Definition at line 231 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.id ( self )

Properties.

ID used to distinguish the RT system.

Typically in the format '[vendor name].[system name].[version]'.

Definition at line 133 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.id	(	self,
		id
	)

Definition at line 142 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.initializing ( self )

Ordering and conditions for when the RT system is initialised.

Definition at line 324 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.initializing	(	self,
		initializing
	)

Definition at line 329 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.optional_data_connections ( self )

Finds all data connections in which one or more components are not
required.

If all the components involved in a connection are required, that
connection is also required. If one or more are not required, that
connection is optional.

Definition at line 416 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.optional_service_connections ( self )

Finds all service connections in which one or more components are
not required.

If all the components involved in a connection are required, that
connection is also required. If one or more are not required, that
connection is optional.

Definition at line 433 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.parse_from_xml	(	self,
		xml_spec
	)

XML.

Parse a string or file containing an XML specification.

Definition at line 485 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.parse_from_yaml	(	self,
		yaml_spec
	)

YAML.

Parse a string or file containing a YAML specification.

Definition at line 502 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.properties ( self )

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 382 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.properties	(	self,
		properties
	)

Definition at line 393 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.required_data_connections ( self )

Finds all data connections in which all components are required.

If all the components involved in a connection are required, that
connection is also required. If one or more are not required, that
connection is optional.

Definition at line 450 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.required_service_connections ( self )

Finds all service connections in which all components are required.

If all the components involved in a connection are required, that
connection is also required. If one or more are not required, that
connection is optional.

Definition at line 466 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.resetting ( self )

Ordering and conditions for when the RT system is reset.

Definition at line 313 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.resetting	(	self,
		resetting
	)

Definition at line 318 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.save_to_xml ( self )

Save this RtsProfile into an XML-formatted string.

Definition at line 494 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.save_to_yaml ( self )

Save this RtsProfile into a YAML-formatted string.

Definition at line 506 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.service_port_connectors ( self )

Connections between service ports in the RT system.

Members are of type @ref ServicePortConnector.

Definition at line 253 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.service_port_connectors	(	self,
		service_port_connectors
	)

Definition at line 262 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.shutdown ( self )

Ordering and conditions for when the RT system is shut down.

Definition at line 280 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.shutdown	(	self,
		shutdown
	)

Definition at line 285 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.startup ( self )

Ordering and conditions for when the RT system is started.

Definition at line 269 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.startup	(	self,
		startup
	)

Definition at line 274 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.update_date ( self )

The date this RT system was most recently updated.

Usually set automatically by the tool that created the system.

Definition at line 179 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.update_date	(	self,
		update_date
	)

Definition at line 188 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.version ( self )

Version of the RTSProfile specification this is in.

Definition at line 194 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.version	(	self,
		version
	)

Definition at line 199 of file rts_profile.py.

def rtsprofile.rts_profile.RtsProfile.version_up_log ( self )

Log entries for new versions.

When an update to a system is made, the log entry describing changes is
stored in this value.

Part of the extended profile.

Definition at line 364 of file rts_profile.py.