component

VIRTUTECH CONFIDENTIAL Previous - Up - Next

Attributes inherited from class conf-object

attributes, classname, component, iface, name, object_id, queue

Attributes inherited from class log-object

access_count, log_buffer, log_buffer_last, log_buffer_size, log_group_mask, log_groups, log_level, log_type_mask

Attribute List

connections: Optional attribute; read/write access; type: [[sos]*].
List of connections for the component. The format is a list of lists, each containing the name of the connector, the connected component, and the name of the connector on the other component.

connectors: Pseudo class attribute; read-only access; type: D.
Dictionary of dictionaries with connectors defined by this component class, indexed by name. Each connector contains the name of the connector "type", a "direction" ("up", "down" or "any"), a flag indicating if the connector can be "empty", another flag that is set if the connector is "hotplug" capable, and finally a flag that is TRUE if muliple connections to this connector is allowed.

instantiated: Optional attribute; read/write access; type: b.
Set to TRUE if the component has been instantiated.

object_list: Optional attribute; read/write access; type: D.
Dictionary with objects that the component consists of.

object_prefix: Optional attribute; read/write access; type: String.
Object prefix string used by the component. The prefix is typically set by the set-component-prefix command before the component is created.

top_component: Optional attribute; read/write access; type: Object.
The top level component. Attribute is not valid until the component has been instantiated.

top_level: Optional attribute; read/write access; type: b.
Set to TRUE for top-level components, i.e. the root of a hierarchy.

Commands defined by interface log_object

log, log-group, log-level, log-size, log-type

Commands

connect	connect components
disconnect	disconnect component connector
get-component-object	get named object from components
info	print information about the device
status	print status of the device

<component>.connect
Synopsis: <component>.connect ["connector"] [component] ["dst-connector"] [-f]
Description: Connects the connector of this component to the dst-connector connector of component. If only a single connector pair on the two components have maching types, then the connector arguments to the command can be left out. Similarly it is possible to give a connector name for only one of the components if there is a single matching connector on the other component. The -f flag tells the command to use the first unused connector (in alphabetic order) if several ones match.

<component>.disconnect
Synopsis: <component>.disconnect ["connector"] [component] ["dst-connector"]
Description: Disconnects the connector from another component connector. Connectors can only be disconnected if they support hotplugging.

<component>.get-component-object
Synopsis: <component>.get-component-object "object"
Description: Get the configuration object with name object from the component. The objects that a component consists of are listed in the object_list attribute.

<component>.info
Synopsis: <component>.info
Description: Print detailed information about the configuration of the device.

<component>.status
Synopsis: <component>.status
Description: Print detailed information about the current status of the device.

VIRTUTECH CONFIDENTIAL Previous - Up - Next