jp.go.aist.rtm.RTC.port
クラス OutPort<DataType>

java.lang.Object
  上位を拡張 org.omg.PortableServer.Servant
      上位を拡張 RTC.PortServicePOA
          上位を拡張 jp.go.aist.rtm.RTC.port.PortBase
              上位を拡張 jp.go.aist.rtm.RTC.port.OutPortBase
                  上位を拡張 jp.go.aist.rtm.RTC.port.OutPort<DataType>
型パラメータ:
DataType - データ型を指定する。
すべての実装されたインタフェース:
SDOServiceOperations, org.omg.CORBA.portable.InvokeHandler, PortServiceOperations

public class OutPort<DataType>
extends OutPortBase

出力ポートの実装。

さらに上位の出力ポートのベース実装として利用される。


入れ子のクラスの概要
 
クラス jp.go.aist.rtm.RTC.port.OutPortBase から継承された入れ子のクラス/インタフェース
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
 
フィールドの概要
 
クラス jp.go.aist.rtm.RTC.port.OutPortBase から継承されたフィールド
m_connectors, m_consumerTypes, m_listeners, m_properties, m_providerTypes, m_publishers
 
クラス jp.go.aist.rtm.RTC.port.PortBase から継承されたフィールド
m_connectionLimit, m_connectorsMutex, m_objref, m_onConnected, m_onConnectionLost, m_onDisconnected, m_onPublishInterfaces, m_onSubscribeInterfaces, m_onUnsubscribeInterfaces, m_ownerInstanceName, m_profile, m_profile_mutex, rtcout
 
コンストラクタの概要
OutPort(BufferBase<DataType> buffer, java.lang.String name, DataRef<DataType> valueRef)
          コンストラクタ 指定されたバッファを割り当てる。
OutPort(java.lang.String name, DataRef<DataType> valueRef)
          コンストラクタ 内部的にバッファが生成されて割り当てられる。
OutPort(java.lang.String name, DataRef<DataType> valueRef, int length)
          コンストラクタ 指定されたデータ長で内部的にバッファが生成されて割り当てられvyる。
 
メソッドの概要
static Time get_timestamp()
          タイムスタンプを取得する。
(package private)  ReturnCode getStatus(int index)
          特定のコネクタへの書き込みステータスを得る {@.ja OutPort は接続ごとに Connector と呼ばれる仮想データチャネルを持 つ。
(package private)  java.util.Vector<ReturnCode> getStatusList()
          特定のコネクタへの書き込みステータスリストを得る {@.ja OutPort は接続ごとに Connector と呼ばれる仮想データチャネルを持 つ。
 boolean insert(DataType value)
          データ書き込み {@.ja ポートへデータを書き込む。
 void onConnect(java.lang.String id, PublisherBase publisher)
           onConnect
 void onDisconnect(java.lang.String id)
           onDisconenct
 void setOnConnect(OnConnect on_connect)
           Set OnConnect callback
 void setOnDisconnect(OnDisconnect on_disconnect)
           Set OnDisConnect callback
 void setOnOverflow(OnOverflow<DataType> onOverflow)
          バッファフルにデータ書き込みできない場合に呼び出される コールバックインタフェースを設定する。
 void setOnRead(OnRead<DataType> onRead)
          データ読み出しの直前に呼び出されるコールバックインタフェースを 設定する。
 void setOnReadConvert(OnReadConvert<DataType> onReadConvert)
          データ読み出し時に呼び出されるコールバックインタフェースを 設定する。
 void setOnUnderflow(OnUnderflow<DataType> onUnderflow)
          バッファ空により読み取れるデータがない場合に呼び出される コールバックインタフェースを設定する。
 void setOnWrite(OnWrite<DataType> onWrite)
          データ書き込み直前に呼び出されるコールバックインタフェースを 設定する。
 void setOnWriteConvert(OnWriteConvert<DataType> onWriteConvert)
          データ書き込み時に呼び出されるコールバックインタフェースを 設定する。
 void setReadBlock(boolean block)
          データ読み出し時における、ブロック/非ブロックモードを指定する。
 void setReadTimeout(long timeout)
          読み出しがブロックモード指定されている場合のタイムアウト時間を 設定する。
 boolean setStreamable(org.omg.CORBA.portable.Streamable holderStreamable)
          CDR化で使用するStreamableを設定する {@.ja 与えられたStreamableをCDR化で使用するStreamableへ設定する。
 void setTimestamp(DataType data)
          タイムスタンプを設定する。
 void setWriteBlock(boolean block)
          データ書き込み時における、ブロック/非ブロックモードを指定する。
 void setWriteTimeout(long timeout)
          書き込みがブロックモード指定されている場合のタイムアウト時間を 設定する。
 void write_stream(DataType data, org.omg.CORBA.portable.OutputStream cdr)
          OutputStreamに整列化する
 boolean write()
          データを書き込む。
 boolean write(DataType value)
          データ書き込み {@.ja ポートへデータを書き込む。
 
クラス jp.go.aist.rtm.RTC.port.OutPortBase から継承されたメソッド
activateInterfaces, addConnectorDataListener, addConnectorDataListener, addConnectorListener, addConnectorListener, configure, connect, connectors, createConnector, createConnector, createConsumer, createProvider, deactivateInterfaces, getConnectorById, getConnectorByName, getConnectorIds, getConnectorNames, getConnectorProfileById, getConnectorProfileByName, getConnectorProfiles, init, initConsumers, initProviders, isLittleEndian, properties, publishInterfaces, removeConnectorDataListener, removeConnectorListener, subscribeInterfaces, unsubscribeInterfaces
 
クラス jp.go.aist.rtm.RTC.port.PortBase から継承されたメソッド
_publishInterfaces, _this, addProperty, appendInterface, appendProperty, checkPorts, connectNext, deleteInterface, disconnect_all, disconnect, disconnectNext, eraseConnectorProfile, findConnProfile, findConnProfileIndex, get_connector_profile, get_connector_profiles, get_port_profile, getName, getPortProfile, getPortRef, getProfile, getUUID, isEmptyId, isExistingConnId, notify_connect, notify_disconnect, setConnectionLimit, setName, setOnConnected, setOnConnectionLost, setOnDisconnected, setOnPublishInterfaces, setOnSubscribeInterfaces, setOnUnsubscribeInterfaces, setOwner, setPortRef, setUUID, updateConnectorProfile, updateConnectors
 
クラス 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
 

コンストラクタの詳細

OutPort

public OutPort(java.lang.String name,
               DataRef<DataType> valueRef)
コンストラクタ

内部的にバッファが生成されて割り当てられる。

パラメータ:
name - ポート名
valueRef - 本ポートにバインドするデータ変数を内包するDataRefオブジェクト

OutPort

public OutPort(java.lang.String name,
               DataRef<DataType> valueRef,
               int length)
コンストラクタ

指定されたデータ長で内部的にバッファが生成されて割り当てられvyる。

パラメータ:
name - ポート名
valueRef - 本ポートにバインドするデータ変数を内包するDataRefオブジェクト
length - バッファ長

OutPort

public OutPort(BufferBase<DataType> buffer,
               java.lang.String name,
               DataRef<DataType> valueRef)
コンストラクタ

指定されたバッファを割り当てる。

パラメータ:
buffer - 割り当てるバッファ
name - ポート名
valueRef - 本ポートにバインドするデータ変数を内包するDataRefオブジェクト
メソッドの詳細

write_stream

public void write_stream(DataType data,
                         org.omg.CORBA.portable.OutputStream cdr)
OutputStreamに整列化する

パラメータ:
data - データ
cdr - OutputStream

setTimestamp

public void setTimestamp(DataType data)
タイムスタンプを設定する。

This function sets the timestamp.

パラメータ:
data - 対象データ

get_timestamp

public static Time get_timestamp()
タイムスタンプを取得する。

戻り値:
取得したTime

write

public boolean write(DataType value)
データ書き込み

ポートへデータを書き込む。

パラメータ:
value - 書き込み対象データ
戻り値:
書き込み処理結果(書き込み成功:true、書き込み失敗:false)

write

public boolean write()
データを書き込む。

本ポートにバインドされているデータ変数の値が書き込まれる。

定義:
クラス OutPortBase 内の write
戻り値:
データを書き込めた場合はtrueを、さもなくばfalseを返す。

insert

public boolean insert(DataType value)
データ書き込み

ポートへデータを書き込む。設定された値をポートに書き込む。

パラメータ:
value - 書き込み対象データ
戻り値:
書き込み処理結果(書き込み成功:true、書き込み失敗:false)

setReadBlock

public void setReadBlock(boolean block)
データ読み出し時における、ブロック/非ブロックモードを指定する。

ブロックモードを指定した場合は、 読み出せるデータを受信するかタイムアウトになるまで、 read()メソッドの呼び出しがブロックされる。

パラメータ:
block - ブロックモードを指定する場合はtrue、さもなくばfalse

setWriteBlock

public void setWriteBlock(boolean block)
データ書き込み時における、ブロック/非ブロックモードを指定する。

ブロックモードを指定した場合は、 バッファに書き込む余地ができるかタイムアウトになるまで、 write()メソッドの呼び出しがブロックされる。

パラメータ:
block - ブロックモードを指定する場合はtrue、さもなくばfalse

setReadTimeout

public void setReadTimeout(long timeout)
読み出しがブロックモード指定されている場合のタイムアウト時間を 設定する。

パラメータ:
timeout - タイムアウト時間 [usec]

setWriteTimeout

public void setWriteTimeout(long timeout)
書き込みがブロックモード指定されている場合のタイムアウト時間を 設定する。

パラメータ:
timeout - タイムアウト時間 [usec]

getStatus

ReturnCode getStatus(int index)
特定のコネクタへの書き込みステータスを得る

OutPort は接続ごとに Connector と呼ばれる仮想データチャネルを持 つ。write() 関数はこれら Connector に対してデータを書き込むが、 各 Connector は書き込みごとにステータスを返す。write() 関数では、 すべての Connector が正常終了したときのみ true を返し、それ以外 では false を返却する。この関数は write() が false の場合ステー タスを調べるのに使用することができる。

パラメータ:
index - Connector の index
戻り値:
ステータス

getStatusList

java.util.Vector<ReturnCode> getStatusList()
特定のコネクタへの書き込みステータスリストを得る

OutPort は接続ごとに Connector と呼ばれる仮想データチャネルを持 つ。write() 関数はこれら Connector に対してデータを書き込むが、 各 Connector は書き込みごとにステータスを返す。write() 関数では、 すべての Connector が正常終了したときのみ true を返し、それ以外 では false を返却する。この関数は write() が false の場合ステー タスを調べるのに使用することができる。

戻り値:
ステータスリスト

setOnWrite

public void setOnWrite(OnWrite<DataType> onWrite)
データ書き込み直前に呼び出されるコールバックインタフェースを 設定する。

パラメータ:
onWrite - OnWriteコールバックインタフェースを持つオブジェクト

setOnWriteConvert

public void setOnWriteConvert(OnWriteConvert<DataType> onWriteConvert)
データ書き込み時に呼び出されるコールバックインタフェースを 設定する。

設定されたコールバックの戻り値のデータが書き込まれる。 これにより、書き込みデータのフィルタリングを行うことがでる。

パラメータ:
onWriteConvert - OutWriteConvertコールバックインタフェースを持つオブジェクト

setOnOverflow

public void setOnOverflow(OnOverflow<DataType> onOverflow)
バッファフルにデータ書き込みできない場合に呼び出される コールバックインタフェースを設定する。

パラメータ:
onOverflow - OutOverflowコールバックインタフェースを持つオブジェクト

setOnRead

public void setOnRead(OnRead<DataType> onRead)
データ読み出しの直前に呼び出されるコールバックインタフェースを 設定する。

パラメータ:
onRead - OutReadコールバックインタフェースを持つオブジェクト

setOnReadConvert

public void setOnReadConvert(OnReadConvert<DataType> onReadConvert)
データ読み出し時に呼び出されるコールバックインタフェースを 設定する。

設定されたコールバックの戻りデータ値が読み出される。 これにより、読み出しデータをフィルタリングすることができる。

パラメータ:
onReadConvert - OutReadConvertコールバックインタフェースを持つオブジェクト

setOnUnderflow

public void setOnUnderflow(OnUnderflow<DataType> onUnderflow)
バッファ空により読み取れるデータがない場合に呼び出される コールバックインタフェースを設定する。

パラメータ:
onUnderflow - OutUnderflowコールバックインタフェースを持つオブジェクト

setOnConnect

public void setOnConnect(OnConnect on_connect)

Set OnConnect callback


setOnDisconnect

public void setOnDisconnect(OnDisconnect on_disconnect)

Set OnDisConnect callback


onConnect

public void onConnect(java.lang.String id,
                      PublisherBase publisher)
クラス OutPortBase の記述:

onConnect

オーバーライド:
クラス OutPortBase 内の onConnect

onDisconnect

public void onDisconnect(java.lang.String id)
クラス OutPortBase の記述:

onDisconenct

オーバーライド:
クラス OutPortBase 内の onDisconnect

setStreamable

public boolean setStreamable(org.omg.CORBA.portable.Streamable holderStreamable)
CDR化で使用するStreamableを設定する

与えられたStreamableをCDR化で使用するStreamableへ設定する。 また、与えられたStreamableからvalueフィールドを取得し保持する。

パラメータ:
holderStreamable - HolderクラスのStreamable
戻り値:
false 失敗