jp.go.aist.rtm.RTC.port

クラス EventInPort<FsmType extends MachineBase>

java.lang.Object

org.omg.PortableServer.Servant

RTC.PortServicePOA

jp.go.aist.rtm.RTC.port.PortBase

jp.go.aist.rtm.RTC.port.InPortBase

jp.go.aist.rtm.RTC.port.EventInPort<FsmType>

すべての実装されたインタフェース:

SDOServiceOperations, org.omg.CORBA.portable.InvokeHandler, PortServiceOperations

public class EventInPort<FsmType extends MachineBase>
extends InPortBase

EventInPort テンプレートクラス

EventInPort の実装である EventInPort のテンプレートクラス。 はBasicDataType.idl にて定義されている型で、メンバとして Time 型の tm , および T型の data を持つ構造体でなくてはならない。 EventInPort は内部にリングバッファを持ち、外部から送信されたデータを順次 このリングバッファに格納する。リングバッファのサイズはデフォルトで64と なっているが、コンストラクタ引数によりサイズを指定することができる。 データはフラグによって未読、既読状態が管理され、isNew(), write(), read(), isFull(), isEmpty() 等のメソッドによりハンドリングすることができる。 OnRead系コールバック (読み出しに起因するイベントによりコールされる)

• - void OnRead::operator(): EventInPort::read() を呼び出し読み出しを行う際にコールされる。
• - DataType OnReadConvert::operator(DataType): EventInPort::read() を呼び出し、データをバッファから読みだす際に呼ばれ データの変換を行う。引数にはバッファから読み出された値が与えられ、 変換後のデータを戻り値として返す。この値がread()の返す値となる。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
(package private) class	EventInPort.EventBinder0
(package private) class	EventInPort.EventBinder1<DataType>

クラスから継承されたネストされたクラス/インタフェース 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.InPortBase

m_connectors, m_consumerTypes, m_listeners, m_properties, m_providerTypes, m_singlebuffer, m_thebuffer

クラスから継承されたフィールド jp.go.aist.rtm.RTC.port.PortBase

m_connectionLimit, m_connectorsMutex, m_objref, m_onConnected, m_onConnectionLost, m_onConnectionLost_mutex, m_onDisconnected, m_onPublishInterfaces, m_onSubscribeInterfaces, m_onUnsubscribeInterfaces, m_ownerInstanceName, m_portconnListeners, m_profile, m_profile_mutex, rtcout

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
EventInPort(java.lang.String name, DataRef<FsmType> fsm)
EventInPort(java.lang.String name, DataRef<FsmType> fsm, boolean read_block, boolean write_block, long read_timeout, long write_timeout) コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	bindEvent(java.lang.String name, java.lang.String handler)
<DataType> void	bindEvent(java.lang.String name, java.lang.String handler, DataType data)
java.lang.String	name() ポート名称を取得する。
boolean	read() RTObject_impl::readAll()から呼ばれる仮想関数

クラスから継承されたメソッド jp.go.aist.rtm.RTC.port.InPortBase

activateInterfaces, addConnectorDataListener, addConnectorDataListener, addConnectorDataListener, addConnectorDataListener, addConnectorListener, addConnectorListener, connect, connectors, createConnector, createConnector, createConsumer, createProvider, deactivateInterfaces, getConnectorById, getConnectorByName, getConnectorIds, getConnectorNames, getConnectorProfileById, getConnectorProfileByName, getConnectorProfiles, getListeners, getLocalOutPort, init, initConsumers, initProviders, isLittleEndian, notify_connect, properties, publishInterfaces, removeConnectorDataListener, 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_disconnect, onConnected, onConnectNextport, onDisconnected, onDisconnectNextport, onNotifyConnect, onNotifyDisconnect, onPublishInterfaces, onSubscribeInterfaces, onUnsubscribeInterfaces, setConnectionLimit, setName, setOnConnected, setOnConnectionLost, setOnDisconnected, setOnPublishInterfaces, setOnSubscribeInterfaces, setOnUnsubscribeInterfaces, setOwner, setPortConnectListenerHolder, 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

コンストラクタの詳細

EventInPort

public EventInPort(java.lang.String name,
                   DataRef<FsmType> fsm,
                   boolean read_block,
                   boolean write_block,
                   long read_timeout,
                   long write_timeout)

コンストラクタ

パラメータとして与えられる T 型の変数にバインドされる。

パラメータ:

name - EventInPort 名。EventInPortBase:name() により参照される。

fsm - この EventInPort にバインドされる T 型の変数

read_block - 読込ブロックフラグ。 データ読込時に未読データがない場合、次のデータ受信までブロックする かどうかを設定(デフォルト値:false)

write_block - 書込ブロックフラグ。 データ書込時にバッファがフルであった場合、バッファに空きができる までブロックするかどうかを設定(デフォルト値:false)

read_timeout - 読込ブロックを指定していない場合の、データ読取タイム アウト時間(ミリ秒)(デフォルト値:0)

write_timeout - 書込ブロックを指定していない場合の、データ書込タイム アウト時間(ミリ秒)(デフォルト値:0)

EventInPort

public EventInPort(java.lang.String name,
                   DataRef<FsmType> fsm)

メソッドの詳細

name

public java.lang.String name()

ポート名称を取得する。

ポート名称を取得する。

戻り値:

ポート名称

bindEvent

public <DataType> void bindEvent(java.lang.String name,
                                 java.lang.String handler,
                                 DataType data)

bindEvent

public void bindEvent(java.lang.String name,
                      java.lang.String handler)

read

public boolean read()

クラスからコピーされた説明: InPortBase

RTObject_impl::readAll()から呼ばれる仮想関数

DataPort からデータを読み出す

定義:

read クラス内 InPortBase

戻り値:

true:成功,false:失敗