OpenRTM-aist IDL  1.2
Public Member Functions | List of all members
RTC::PortService Interface Reference

PortService. More...

import"RTC.idl";

Inheritance diagram for RTC::PortService:
Inheritance graph
[legend]
Collaboration diagram for RTC::PortService:
Collaboration graph
[legend]

Public Member Functions

PortProfile get_port_profile ()
 get_port_profile More...
 
ConnectorProfileList get_connector_profiles ()
 get_connector_profiles More...
 
ConnectorProfile get_connector_profile (in UniqueIdentifier connector_id)
 get_connector_profiles More...
 
ReturnCode_t connect (inout ConnectorProfile connector_profile)
 connect More...
 
ReturnCode_t disconnect (in UniqueIdentifier connector_id)
 disconnect More...
 
ReturnCode_t disconnect_all ()
 disconnect_all More...
 
ReturnCode_t notify_connect (inout ConnectorProfile connector_profile)
 notify_connect More...
 
ReturnCode_t notify_disconnect (in UniqueIdentifier connector_id)
 notify_disconnect More...
 

Detailed Description

PortService.

Description

An instance of the PortService interface represents a port (i.e., UML::Composite Structures::Ports::Port) of an RTC. It provides operations that allow it to be connected to and disconnected from other ports.

Semantics

A port service can support unidirectional or bidirectional communication. A port service may allow for a service-oriented connection, in which other connected ports, invoke methods on it. It may also allow for a data-centric connection, in which data values are streamed in or out. In either case, the connection is described by an instance of ConnectorProfile. However, the behavioral contracts of such connections are dependent on the interfaces exposed by the ports and are not described normatively by this specification.

Member Function Documentation

ReturnCode_t RTC::PortService::connect ( inout ConnectorProfile  connector_profile)

connect

Description

This operation establishes connection between this port and the peer ports according to given ConnectionProfile.

Semantics

A ConnectorProfile has a sequence of port references. This port invokes the notify_connect operation of one of the ports included in the sequence. It follows that the notification of connection is propagated by the notify_connect operation with ConnectorProfile. This operation returns ConnectorProfile return value and returns ReturnCode_t as return codes.

ReturnCode_t RTC::PortService::disconnect ( in UniqueIdentifier  connector_id)

disconnect

Description

This operation destroys the connection between this port and its peer ports using the ID that was given when the connection was established.

Semantics

This port invokes the notify_disconnect operation of one of the ports included in the sequence of the ConnectorProfile stored when the connection was established. The notification of disconnection is propagated by the notify_disconnect operation.

ReturnCode_t RTC::PortService::disconnect_all ( )

disconnect_all

Description

This operation destroys all connection channels owned by the PortService.

ConnectorProfile RTC::PortService::get_connector_profile ( in UniqueIdentifier  connector_id)

get_connector_profiles

Description

This operation returns a list of the ConnectorProfiles of the PortService.

ConnectorProfileList RTC::PortService::get_connector_profiles ( )

get_connector_profiles

Description

This operation returns a list of the ConnectorProfiles of the PortService.

PortProfile RTC::PortService::get_port_profile ( )

get_port_profile

Description

This operation returns the PortProfile of the PortService.

ReturnCode_t RTC::PortService::notify_connect ( inout ConnectorProfile  connector_profile)

notify_connect

Description

This operation notifies this PortService of the connection between its corresponding port and the other ports and propagates the given ConnectionProfile.

Semantics

A ConnectorProfile has a sequence of port references. This PortService stores the ConnectorProfile and invokes the notify_connect operation of the next PortService in the sequence. As ports are added to the connector, PortService references are added to the ConnectorProfile and provided to the caller. In this way, notification of connection is propagated with the ConnectorProfile.

ReturnCode_t RTC::PortService::notify_disconnect ( in UniqueIdentifier  connector_id)

notify_disconnect

Description

This operation notifies a PortService of a disconnection between its corresponding port and the other ports. The disconnected connector is identified by the given ID, which was given when the connection was established.

Semantics

This port invokes the notify_disconnect operation of the next PortService in the sequence of the ConnectorProfile that was stored when the connection was established. As ports are disconnected, PortService references are removed from the ConnectorProfile. In this way, the notification of disconnection is propagated by the notify_disconnect operation.


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