public class OutPortDirectConsumer extends java.lang.Object implements OutPortConsumer, ObjectCreator<OutPortConsumer>, ObjectDestructor
This is an implementation class of the input port Consumer
that uses CORBA for means of communication. The OutPort consumer class which uses the OpenRTM::OutPortCdr interface in CORBA for data transfer and realizes a push-type dataflow.Constructor and Description |
---|
OutPortDirectConsumer()
Constructor
|
Modifier and Type | Method and Description |
---|---|
protected ReturnCode |
convertReturn(PortStatus status)
Converts PortStatus into ReturnCode.
|
OutPortConsumer |
creator_()
Creats OutPortDirectConsumer
|
void |
destructor_(java.lang.Object obj)
Destructs Object
|
ReturnCode |
get(org.omg.CORBA.portable.OutputStream data)
Pure virtual function to receive data.
|
void |
init(Properties prop)
Initializing configuration
|
static void |
OutPortDirectConsumerInit()
Module initialization
|
void |
publishInterfaceProfile(NVListHolder properties)
Publish InterfaceProfile information
|
ReturnCode |
put(org.omg.CORBA.portable.OutputStream data)
Send data to the destination port
|
void |
setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
Setting outside buffer's pointer
|
void |
setConnector(InPortConnector connector)
set Connector
|
void |
setListener(ConnectorBase.ConnectorInfo info,
ConnectorListeners listeners) |
boolean |
subscribeInterface(NVListHolder properties)
Subscribe to the data sending notification
|
void |
unsubscribeInterface(NVListHolder properties)
Unsubscribe the data send notification
|
public OutPortDirectConsumer()
buffer 当該コンシューマに割り当てるバッファオブジェクト buffer The buffer object that is attached to this Consumer
public void init(Properties prop)
This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.
init
in interface OutPortConsumer
prop
-
Configuration informationpublic ReturnCode put(org.omg.CORBA.portable.OutputStream data)
Pure virtual function to send data to the destination port. This function might the following return codes
data
-
Data sent by this operation.public void publishInterfaceProfile(NVListHolder properties)
Publish interfaceProfile information. Check the dataport.interface_type value of the NameValue object specified by an argument in property information and get information only when the interface type of the specified port is matched.
properties
-
Properties to get InterfaceProfile informationpublic boolean subscribeInterface(NVListHolder properties)
Subscribe to the data sending notification based on specified property information.
subscribeInterface
in interface OutPortConsumer
properties
-
Information for subscriptionpublic void unsubscribeInterface(NVListHolder properties)
Unsubscribe the data send notification.
unsubscribeInterface
in interface OutPortConsumer
properties
-
Information for unsubscriptionprotected ReturnCode convertReturn(PortStatus status)
status
-
PortStatuspublic OutPortConsumer creator_()
creator_
in interface ObjectCreator<OutPortConsumer>
public void destructor_(java.lang.Object obj)
destructor_
in interface ObjectDestructor
obj
-
The target instances for destructionpublic static void OutPortDirectConsumerInit()
This initialization function registers OutPortDirectConsumer's factory.
public void setConnector(InPortConnector connector)
setConnector
in interface OutPortConsumer
connector
-
InPortConnectorpublic void setListener(ConnectorBase.ConnectorInfo info, ConnectorListeners listeners)
setListener
in interface OutPortConsumer
public ReturnCode get(org.omg.CORBA.portable.OutputStream data)
OutPortConsumer
Pure virtual function to receive data.
get
in interface OutPortConsumer
public void setBuffer(BufferBase<org.omg.CORBA.portable.OutputStream> buffer)
OutPortConsumer
Setting outside buffer's pointer
A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.
setBuffer
in interface OutPortConsumer
buffer
- A pointer to a data buffer to be used by OutPortProvider