jp.go.aist.rtm.RTC.port

Class InPortSHMConsumer

java.lang.Object

jp.go.aist.rtm.RTC.port.CorbaConsumerBase

jp.go.aist.rtm.RTC.port.CorbaConsumer<PortSharedMemory>

jp.go.aist.rtm.RTC.port.InPortSHMConsumer

All Implemented Interfaces:

ObjectCreator<InPortConsumer>, ObjectDestructor, InPortConsumer

public class InPortSHMConsumer
extends CorbaConsumer<PortSharedMemory>
implements InPortConsumer, ObjectCreator<InPortConsumer>, ObjectDestructor

InPortSHMConsumer class

This is an implementation class of the input port Consumer that uses shared memory for means of communication.

Field Summary

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

m_sev, m_var

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

m_objref

Constructor Summary

Constructors

Constructor and Description
InPortSHMConsumer() Constructor

Method Summary

Modifier and Type	Method and Description
protected ReturnCode	convertReturn(PortStatus status) Converts PortStatus into ReturnCode.
InPortConsumer	creator_() Creats InPortSHMConsumer
void	destructor_(java.lang.Object obj) Destructs Object
void	init(Properties prop) Initializing configuration
static void	InPortSHMConsumerInit() Module initialization
void	publishInterfaceProfile(NVListHolder properties) Publish InterfaceProfile information
ReturnCode	put(org.omg.CORBA.portable.OutputStream data) Send data to the destination port
void	setConnector(OutPortConnector connector) set Connector
boolean	setObject(org.omg.CORBA.Object obj) CORBAオブジェクトを設定します。
boolean	subscribeInterface(NVListHolder properties) Subscribe to the data sending notification
void	unsubscribeInterface(NVListHolder properties) Unsubscribe the data send notification

Methods inherited from class jp.go.aist.rtm.RTC.port.CorbaConsumer

_ptr, releaseObject

Methods inherited from class jp.go.aist.rtm.RTC.port.CorbaConsumerBase

getObject

Methods inherited from class java.lang.Object

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

Constructor Detail

InPortSHMConsumer

public InPortSHMConsumer()

Constructor

buffer 当該コンシューマに割り当てるバッファオブジェクト buffer The buffer object that is attached to this Consumer

Method Detail

init

public void init(Properties prop)

Initializing configuration

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.

Specified by:

init in interface InPortConsumer

Parameters:

prop - Configuration information

setObject

public boolean setObject(org.omg.CORBA.Object obj)

CORBAオブジェクトを設定します。

Overrides:

setObject in class CorbaConsumer<PortSharedMemory>

Parameters:

obj - CORBAオブジェクト

Returns:

設定に成功した場合はtrueを、さもなくばflaseを返します。

put

public ReturnCode put(org.omg.CORBA.portable.OutputStream data)

Send data to the destination port

Pure virtual function to send data to the destination port. This function might the following return codes

• - PORT_OK: Normal return
• - PORT_ERROR: Error occurred in data transfer process
• - SEND_FULL: Buffer full although OutPort tried to send data
• - SEND_TIMEOUT: Timeout although OutPort tried to send data
• - UNKNOWN_ERROR: Unknown error

Specified by:

put in interface InPortConsumer

Parameters:

data - Data sent by this operation.

Returns:

ReturnCode

publishInterfaceProfile

public void publishInterfaceProfile(NVListHolder properties)

Publish InterfaceProfile information

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.

Specified by:

publishInterfaceProfile in interface InPortConsumer

Parameters:

properties - Properties to get InterfaceProfile information

subscribeInterface

public boolean subscribeInterface(NVListHolder properties)

Subscribe to the data sending notification

Subscribe to the data sending notification based on specified property information.

Specified by:

subscribeInterface in interface InPortConsumer

Parameters:

properties - Information for subscription

Returns:

Subscription result (Successful:true, Failed:false)

unsubscribeInterface

public void unsubscribeInterface(NVListHolder properties)

Unsubscribe the data send notification

Unsubscribe the data send notification.

Specified by:

unsubscribeInterface in interface InPortConsumer

Parameters:

properties - Information for unsubscription

convertReturn

protected ReturnCode convertReturn(PortStatus status)

Converts PortStatus into ReturnCode.

Parameters:

status - PortStatus

Returns:

ReturnCode

creator_

public InPortConsumer creator_()

Creats InPortSHMConsumer

Specified by:

creator_ in interface ObjectCreator<InPortConsumer>

Returns:

Object Created instances

destructor_

public void destructor_(java.lang.Object obj)

Destructs Object

Specified by:

destructor_ in interface ObjectDestructor

Parameters:

obj - The target instances for destruction

InPortSHMConsumerInit

public static void InPortSHMConsumerInit()

Module initialization

This initialization function registers InPortSHMConsumer's factory.

setConnector

public void setConnector(OutPortConnector connector)

set Connector

Specified by:

setConnector in interface InPortConsumer

Parameters:

connector - OutPortConnector