DataType
-
The data type is specifiedpublic class OutPort<DataType> extends OutPortBase
This class is used as the base Implementation of a high-ranking output port.
OutPortBase.Publisher
PortBase.connect_func, PortBase.disconnect_all_func, PortBase.disconnect_func, PortBase.find_conn_id, PortBase.find_interface, PortBase.find_port_ref
m_connectors, m_consumerTypes, m_listeners, m_properties, m_providerTypes, m_publishers
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 and Description |
---|
OutPort(BufferBase<DataType> buffer,
java.lang.String name,
DataRef<DataType> valueRef)
Constructor
|
OutPort(java.lang.String name,
DataRef<DataType> valueRef)
Constructor
|
OutPort(java.lang.String name,
DataRef<DataType> valueRef,
int length)
Constructor
|
Modifier and Type | Method and Description |
---|---|
static Time |
get_timestamp()
{@.en Gets the 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 |
read(DataRef<DataType> data)
Readout the value
|
void |
setOnConnect(OnConnect on_connect)
Set OnConnect callback
|
void |
setOnDisconnect(OnDisconnect on_disconnect)
Set OnDisConnect callback
|
void |
setOnOverflow(OnOverflow<DataType> onOverflow)
sets the callback interface called when data cannot be written in
a full buffer.
|
void |
setOnRead(OnRead<DataType> onRead)
sets the callback interface called immediately before reading of
data.
|
void |
setOnReadConvert(OnReadConvert<DataType> onReadConvert)
sets the callback interface called when data is read.
|
void |
setOnUnderflow(OnUnderflow<DataType> onUnderflow)
{@.en sets the callback interface called when there is no data that can
be read in an empty buffer more.
|
void |
setOnWrite(OnWrite<DataType> onWrite)
Sets the callback interface called immediately before writing of
data.
|
void |
setOnWriteConvert(OnWriteConvert<DataType> onWriteConvert)
sets the callback interface called when data is written.
|
void |
setReadBlock(boolean block)
Specifies the block mode in the data reading.
|
void |
setReadTimeout(long timeout)
Sets the timeout period of the block mode of reading.
|
boolean |
setStreamable(org.omg.CORBA.portable.Streamable holderStreamable)
{@.en Sets Streamable.
|
void |
setTimestamp(DataType data)
Sets timestamp.
|
void |
setWriteBlock(boolean block)
Specifies the block mode in the data writing.
|
void |
setWriteTimeout(long timeout)
Sets the timeout period of the block mode of writing.
|
void |
write_stream(DataType data,
org.omg.CORBA.portable.OutputStream cdr)
Marshals to ostream the data.
|
boolean |
write()
Writes the data
|
boolean |
write(DataType value)
Write data
|
activateInterfaces, addConnectorDataListener, addConnectorDataListener, addConnectorDataListener, addConnectorDataListener, addConnectorListener, addConnectorListener, configure, connect, connectors, createConnector, createConnector, createConsumer, createProvider, deactivateInterfaces, getConnectorById, getConnectorByName, getConnectorIds, getConnectorNames, getConnectorProfileById, getConnectorProfileByName, getConnectorProfiles, getListeners, getLocalInPort, init, initConsumers, initProviders, isLittleEndian, notify_connect, properties, publishInterfaces, removeConnectorDataListener, removeConnectorDataListener, removeConnectorListener, subscribeInterfaces, unsubscribeInterfaces
_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
_all_interfaces, _invoke, _this
public OutPort(java.lang.String name, DataRef<DataType> valueRef)
Internally creates and allcoates the buffer
name
-
Name of PortvalueRef
-
DataRef objectpublic OutPort(java.lang.String name, DataRef<DataType> valueRef, int length)
Internally creates and allocates the buffer by the specified data length
name
-
the port namevalueRef
-
DataRef objectlength
-
Buffer lengthpublic OutPort(BufferBase<DataType> buffer, java.lang.String name, DataRef<DataType> valueRef)
Allocates the specified buffer.
buffer
-
buffername
-
Port namevalueRef
-
DataRef objectpublic void write_stream(DataType data, org.omg.CORBA.portable.OutputStream cdr)
data
-
datacdr
-
OutputStreampublic void setTimestamp(DataType data)
This function sets timestamp to data of data port. This data should have tm.sec, tm.nsec as members of the structure.
data
-
Data to be set timestamp. After executing this
function, current timestamp is set to the data.public static Time get_timestamp()
public boolean write(DataType value)
Write data in the port.
value
-
The target data for writingpublic boolean write()
Writes the value in the variable to which bind is done.
write
in class OutPortBase
public boolean insert(DataType value)
Write data to the port. Write the set value to the port.
value
-
The target data for writingpublic void setReadBlock(boolean block)
When the block mode is specified, the read() method is blocked until data is read or until the time-out.
block
-
True when block mode is specifiedpublic void setWriteBlock(boolean block)
When the block mode is specified, the write() method is blocked.
block
-
True when block mode is specifiedpublic void setReadTimeout(long timeout)
timeout
-
Timeout[usec]public void setWriteTimeout(long timeout)
timeout
-
Timeout[usec]ReturnCode getStatus(int index)
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 indexjava.util.Vector<ReturnCode> getStatusList()
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
public void setOnWrite(OnWrite<DataType> onWrite)
onWrite
-
Object with OnWrite callback interfacepublic void setOnWriteConvert(OnWriteConvert<DataType> onWriteConvert)
onWriteConvert
-
Object with OutWriteConvert callback interfacepublic void setOnOverflow(OnOverflow<DataType> onOverflow)
onOverflow
-
Object with OutOverflow callback interfacepublic void setOnRead(OnRead<DataType> onRead)
onRead
-
Object with OutRead callback interfacepublic void setOnReadConvert(OnReadConvert<DataType> onReadConvert)
onReadConvert
-
Object with OutReadConvert callback interfacepublic void setOnUnderflow(OnUnderflow<DataType> onUnderflow)
onUnderflow
-
Object with OutUnderflow callback interfacepublic void setOnConnect(OnConnect on_connect)
Set OnConnect callback
public void setOnDisconnect(OnDisconnect on_disconnect)
Set OnDisConnect callback
public void onConnect(java.lang.String id, PublisherBase publisher)
OutPortBase
onConnect
onConnect
in class OutPortBase
public void onDisconnect(java.lang.String id)
OutPortBase
onDisconenct
onDisconnect
in class OutPortBase
public boolean setStreamable(org.omg.CORBA.portable.Streamable holderStreamable)
This method sets Streamable used when making it to CDR. Moreover, this method acquires the value field from Streamable.
holderStreamable
-
Streamable of Holder class