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)
          コンストラクタです。指定されたデータ長で内部的にバッファが生成されて割り当てられます。
 
メソッドの概要
static Time get_timestamp()
           set_timestamp
(package private)  ReturnCode getStatus(int index)
           brief Getting specified connector's writing status
(package private)  java.util.Vector<ReturnCode> getStatusList()
           Getting specified connector's writing status list
 boolean insert(DataType value)
           Write data
 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)
          データ読み出し時における、ブロック/非ブロックモードを指定します。
ブロックモードを指定した場合は、読み出せるデータを受信するかタイムアウトになるまで、 read()メソッドの呼び出しがブロックされます。
 void setReadTimeout(long timeout)
          読み出しがブロックモード指定されている場合のタイムアウト時間を設定します。
 boolean setStreamable(org.omg.CORBA.portable.Streamable holderStreamable)
           {@.en Sets Streamable.
 void setWriteBlock(boolean block)
          データ書き込み時における、ブロック/非ブロックモードを指定します。
ブロックモードを指定した場合は、バッファに書き込む余地ができるかタイムアウトになるまで、 write()メソッドの呼び出しがブロックされます。
 void setWriteTimeout(long timeout)
          書き込みがブロックモード指定されている場合のタイムアウト時間を設定します。
 void write_stream(DataType data, org.omg.CORBA.portable.OutputStream cdr)
           write_stream
 boolean write()
          データを書き込みます。本ポートにバインドされているデータ変数の値が書き込まれます。
 boolean write(DataType value)
           Write data
 
クラス 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)

コンストラクタです。指定されたデータ長で内部的にバッファが生成されて割り当てられます。

パラメータ:
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)

write_stream

This function writes data from OutputStream.

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

get_timestamp

public static Time get_timestamp()

set_timestamp

This function sets the timestamp.

戻り値:
RTC.Time

write

public boolean write(DataType value)
Write data

Write data in the port.

パラメータ:
value - The target data for writing
戻り値:
Writing result (Successful:true, Failed:false)

write

public boolean write()

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

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

insert

public boolean insert(DataType value)
Write data

Write data to the port. Write the set value to the port.

パラメータ:
value - The target data for writing
戻り値:
Writing result (Successful:true, Failed: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)
brief Getting specified connector's writing status

An OutPort has Connectors that are virtual data stream channel for each connection. "write()" function write into these Connectors, and each Connector returns writing-status. write() function will return a true value if all Connectors return normal status, and a false value will be returned if at least one Connector failed. This function can be used to inspect each return status

パラメータ:
index - Connector index
戻り値:
Writing status

getStatusList

java.util.Vector<ReturnCode> getStatusList()
Getting specified connector's writing status list

An OutPort has Connectors that are virtual data stream channel for each connection. "write()" function write into these Connectors, and each Connector returns writing-status. write() function will return a true value if all Connectors return normal status, and a false value will be returned if at least one Connector failed. This function can be used to inspect each return status

戻り値:
Writing status list

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)
Sets Streamable.

This method sets Streamable used when making it to CDR. Moreover, this method acquires the value field from Streamable.

パラメータ:
holderStreamable - Streamable of Holder class
戻り値:
false Failure