jp.go.aist.rtm.RTC.port

Class 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>

All Implemented Interfaces:

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

public class EventInPort<FsmType extends MachineBase>
extends InPortBase

EventInPort template class

This is a template class that implements EventInPort. is the type defined in BasicDataType.idl and must be the structure which has both Time type tm and type-T data as a member. EventInPort has a ring buffer internally, and stores the received data externally in this buffer one by one. The size of ring buffer can be specified according to the argument of constructor, though the default size is 64. Unread data and data which is already read are managed with the flag, and the data can be handled by the isNew(), write(), read(), isFull() and isEmpty() method etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	EventInPort.EventBinder0
(package private) class	EventInPort.EventBinder1<DataType>

Nested classes/interfaces inherited from class 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

Field Summary

Fields inherited from class jp.go.aist.rtm.RTC.port.InPortBase

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

Fields inherited from class 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

Constructor Summary

Constructors

Constructor and Description
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) A constructor.

Method Summary

Modifier and Type	Method and Description
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() Get port name
boolean	read() It is a virtual method that is called from RTObject_impl::readAll().

Methods inherited from class 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

Methods inherited from class 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

Methods inherited from class RTC.PortServicePOA

_all_interfaces, _invoke, _this

Methods inherited from class 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventInPort

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

A constructor.

This is bound to type-T variable given as a parameter.

Parameters:

name - A name of the EventInPort. This name is referred by EventInPortBase::name().

fsm - type-T variable that is bound to this EventInPort.

read_block - Flag of reading block. When there are not unread data at reading data, set whether to block data until receiving the next data. (The default value:false)

write_block - Flag of writing block. If the buffer was full at writing data, set whether to block data until the buffer has space. (The default value:false)

read_timeout - Data reading timeout time (millisecond) when not specifying read blocking. (The default value:0)

write_timeout - Data writing timeout time (millisecond) when not specifying writing block. (The default value:0)

EventInPort

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

Method Detail

name

public java.lang.String name()

Get port name

Get port name.

Returns:

The port 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()

Description copied from class: InPortBase

It is a virtual method that is called from RTObject_impl::readAll().

This method reads out data from DataPort.

Specified by:

read in class InPortBase

Returns:

true:Success,false:Failure