jp.go.aist.rtm.RTC.port
クラス OutPortBase

java.lang.Object
  上位を拡張 org.omg.PortableServer.Servant
      上位を拡張 RTC.PortServicePOA
          上位を拡張 jp.go.aist.rtm.RTC.port.PortBase
              上位を拡張 jp.go.aist.rtm.RTC.port.OutPortBase
すべての実装されたインタフェース:
SDOServiceOperations, org.omg.CORBA.portable.InvokeHandler, PortServiceOperations
直系の既知のサブクラス:
OutPort

public class OutPortBase
extends PortBase

出力ポートのベース実装クラスです。 Publisherの登録やPublisherへのデータ更新通知などの実装を提供します。


入れ子のクラスの概要
protected  class OutPortBase.Publisher
           
 
クラス jp.go.aist.rtm.RTC.port.PortBase から継承された入れ子のクラス/インタフェース
PortBase.connect_func, PortBase.disconnect_all_func, PortBase.disconnect_func, PortBase.find_conn_id, PortBase.find_interface, PortBase.find_port_ref
 
フィールドの概要
protected  java.util.Vector<OutPortConnector> m_connectors
           
protected  java.util.Vector<InPortConsumer> m_consumers
           
protected  java.util.Vector<java.lang.String> m_consumerTypes
           
protected  java.lang.String m_name
          ポート名です。
protected  Properties m_properties
           
protected  java.util.Vector<OutPortProvider> m_providers
           
protected  java.util.Vector<java.lang.String> m_providerTypes
           
protected  java.util.List<OutPortBase.Publisher> m_publishers
           
 
クラス jp.go.aist.rtm.RTC.port.PortBase から継承されたフィールド
m_objref, m_onConnected, m_onConnectionLost, m_onDisconnected, m_onPublishInterfaces, m_onSubscribeInterfaces, m_onUnsubscribeInterfaces, m_profile, m_profile_mutex, rtcout
 
コンストラクタの概要
OutPortBase(java.lang.String name, java.lang.String data_type)
          コンストラクタです。
 
メソッドの概要
 void activateInterfaces()
           Activate all Port interfaces This operation activate all interfaces that is registered in the ports.
protected  void configure()
           Configureing outport This operation configures the outport based on the properties.
 java.util.Vector<OutPortConnector> connectors()
           Connector list This operation returns connector list
protected  OutPortConnector createConnector(ConnectorProfileHolder cprof, Properties prop, InPortConsumer consumer)
           OutPortPushConnector creation
protected  OutPortConnector createConnector(ConnectorProfileHolder cprof, Properties prop, OutPortProvider provider)
           OutPortPullConnector creation
protected  InPortConsumer createConsumer(ConnectorProfileHolder cprof, Properties prop)
           InPort consumer creation
protected  OutPortProvider createProvider(ConnectorProfileHolder cprof, Properties prop)
           OutPort provider creation
 void deactivateInterfaces()
           Deactivate all Port interfaces This operation deactivate all interfaces that is registered in the ports.
 java.util.Vector<java.lang.String> getConnectorIds()
           ConnectorId list This operation returns ConnectorId list
 java.util.Vector<java.lang.String> getConnectorNames()
           Connector name list This operation returns Connector name list
 boolean getConnectorProfileById(java.lang.String id, ConnectorBase.Profile prof)
           Getting ConnectorProfile by name This operation returns ConnectorProfile specified by name
 boolean getConnectorProfileByName(java.lang.String name, ConnectorBase.Profile prof)
           Getting ConnectorProfile by name This operation returns ConnectorProfile specified by name
 java.util.Vector<ConnectorBase.Profile> getConnectorProfiles()
           ConnectorProfile list This operation returns ConnectorProfile list
(package private)  void init(Properties prop)
           Initializing properties This operation initializes outport's properties
protected  void initConsumers()
           InPort consumer initialization
protected  void initProviders()
           OutPort provider initialization
 boolean isLittleEndian()
           
 java.lang.String name()
          ポート名を取得します。
 void onConnect(java.lang.String id, PublisherBase publisher)
           onConnect
 void onDisconnect(java.lang.String id)
           onDisconenct
 Properties properties()
          プロパティを取得する
 boolean publishInterfaceProfiles(NVListHolder properties)
           Publish interface profile This operation publish interface profiles of this OutPort to DataOutPort.
protected  ReturnCode_t publishInterfaces(ConnectorProfileHolder cprof)
           Publish interface information This operation is pure virutal function that would be called at the beginning of the notify_connect() process sequence.
protected  ReturnCode_t subscribeInterfaces(ConnectorProfileHolder cprof)
           Subscribe to the interface This operation is pure virutal function that would be called at the middle of the notify_connect() process sequence.
protected  void unsubscribeInterfaces(ConnectorProfile connector_profile)
          Interfaceの接続を解除します。
 
クラス jp.go.aist.rtm.RTC.port.PortBase から継承されたメソッド
_this, addProperty, appendInterface, appendProperty, connect, connectNext, deleteInterface, disconnect_all, disconnect, disconnectNext, eraseConnectorProfile, findConnProfile, findConnProfileIndex, get_connector_profile, get_connector_profiles, get_port_profile, getPortProfile, getPortRef, getProfile, getUUID, isEmptyId, isExistingConnId, notify_connect, notify_disconnect, setName, setOnConnected, setOnConnectionLost, setOnDisconnected, setOnPublishInterfaces, setOnSubscribeInterfaces, setOnUnsubscribeInterfaces, setOwner, setPortRef, setUUID, updateConnectorProfile
 
クラス RTC.PortServicePOA から継承されたメソッド
_all_interfaces, _invoke, _this
 
クラス org.omg.PortableServer.Servant から継承されたメソッド
_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

m_name

protected java.lang.String m_name

ポート名です。


m_publishers

protected java.util.List<OutPortBase.Publisher> m_publishers

m_properties

protected Properties m_properties

m_connectors

protected java.util.Vector<OutPortConnector> m_connectors

m_consumers

protected java.util.Vector<InPortConsumer> m_consumers

m_providerTypes

protected java.util.Vector<java.lang.String> m_providerTypes

m_consumerTypes

protected java.util.Vector<java.lang.String> m_consumerTypes

m_providers

protected java.util.Vector<OutPortProvider> m_providers
コンストラクタの詳細

OutPortBase

public OutPortBase(java.lang.String name,
                   java.lang.String data_type)

コンストラクタです。

パラメータ:
name - ポート名
data_type -
メソッドの詳細

init

void init(Properties prop)

Initializing properties

This operation initializes outport's properties


properties

public Properties properties()

プロパティを取得する


name

public java.lang.String name()

ポート名を取得します。

戻り値:
ポート名

connectors

public final java.util.Vector<OutPortConnector> connectors()

Connector list

This operation returns connector list

戻り値:
connector list

getConnectorProfiles

public java.util.Vector<ConnectorBase.Profile> getConnectorProfiles()

ConnectorProfile list

This operation returns ConnectorProfile list

戻り値:
connector list

getConnectorIds

public java.util.Vector<java.lang.String> getConnectorIds()

ConnectorId list

This operation returns ConnectorId list

戻り値:
connector list

getConnectorNames

public java.util.Vector<java.lang.String> getConnectorNames()

Connector name list

This operation returns Connector name list

戻り値:
connector name list

getConnectorProfileById

public boolean getConnectorProfileById(java.lang.String id,
                                       ConnectorBase.Profile prof)

Getting ConnectorProfile by name

This operation returns ConnectorProfile specified by name

パラメータ:
id - Connector ID
prof - ConnectorProfile
戻り値:
false specified ID does not exi

getConnectorProfileByName

public boolean getConnectorProfileByName(java.lang.String name,
                                         ConnectorBase.Profile prof)

Getting ConnectorProfile by name

This operation returns ConnectorProfile specified by name

パラメータ:
name -
prof - ConnectorProfile
戻り値:
false specified name does not exist

publishInterfaceProfiles

public boolean publishInterfaceProfiles(NVListHolder properties)

Publish interface profile

This operation publish interface profiles of this OutPort to DataOutPort. This operation should be called from DataOutPort.

パラメータ:
properties - itnerface profile

onConnect

public void onConnect(java.lang.String id,
                      PublisherBase publisher)

onConnect


onDisconnect

public void onDisconnect(java.lang.String id)

onDisconenct


publishInterfaces

protected ReturnCode_t publishInterfaces(ConnectorProfileHolder cprof)

Publish interface information

This operation is pure virutal function that would be called at the beginning of the notify_connect() process sequence. In the notify_connect(), the following methods would be called in order.

- publishInterfaces()

- connectNext()

- subscribeInterfaces()

- updateConnectorProfile()

This operation should create the new connection for the new connector_id, and should update the connection for the existing connection_id.

定義:
クラス PortBase 内の publishInterfaces
パラメータ:
cprof - The connection profile information
戻り値:
The return code of ReturnCode_t type.

subscribeInterfaces

protected ReturnCode_t subscribeInterfaces(ConnectorProfileHolder cprof)

Subscribe to the interface

This operation is pure virutal function that would be called at the middle of the notify_connect() process sequence. In the notify_connect(), the following methods would be called in order.

- publishInterfaces()

- connectNext()

- subscribeInterfaces()

- updateConnectorProfile()

定義:
クラス PortBase 内の subscribeInterfaces
パラメータ:
cprof - The connection profile information
戻り値:
The return code of ReturnCode_t type.

unsubscribeInterfaces

protected void unsubscribeInterfaces(ConnectorProfile connector_profile)
クラス PortBase の記述:

Interfaceの接続を解除します。

このメソッドは、notify_disconnect()処理シーケンスの終わりに呼び出されるテンプレートメソッドです。 notify_disconnect()では、

  1. disconnectNext()
  2. unsubscribeInterfaces()
  3. eraseConnectorProfile()
の順にprotectedメソッドが呼び出されて接続解除処理が行われます。

具象クラスでは、このメソッドをオーバーライドし、引数として 与えられた ConnectorProfile に従い接続解除処理を行います。

定義:
クラス PortBase 内の unsubscribeInterfaces
パラメータ:
connector_profile - 接続プロファイル情報

activateInterfaces

public void activateInterfaces()

Activate all Port interfaces

This operation activate all interfaces that is registered in the ports.

定義:
クラス PortBase 内の activateInterfaces

deactivateInterfaces

public void deactivateInterfaces()

Deactivate all Port interfaces

This operation deactivate all interfaces that is registered in the ports.

定義:
クラス PortBase 内の deactivateInterfaces

configure

protected void configure()

Configureing outport

This operation configures the outport based on the properties.


initProviders

protected void initProviders()

OutPort provider initialization


initConsumers

protected void initConsumers()

InPort consumer initialization


createProvider

protected OutPortProvider createProvider(ConnectorProfileHolder cprof,
                                         Properties prop)

OutPort provider creation


createConsumer

protected InPortConsumer createConsumer(ConnectorProfileHolder cprof,
                                        Properties prop)

InPort consumer creation


createConnector

protected OutPortConnector createConnector(ConnectorProfileHolder cprof,
                                           Properties prop,
                                           InPortConsumer consumer)

OutPortPushConnector creation


createConnector

protected OutPortConnector createConnector(ConnectorProfileHolder cprof,
                                           Properties prop,
                                           OutPortProvider provider)

OutPortPullConnector creation


isLittleEndian

public boolean isLittleEndian()