jp.go.aist.rtm.RTC.port

Class OutPortConnector

java.lang.Object

jp.go.aist.rtm.RTC.port.ConnectorBase

jp.go.aist.rtm.RTC.port.OutPortConnector

Direct Known Subclasses:

OutPortPullConnector, OutPortPushConnector

public abstract class OutPortConnector
extends ConnectorBase

Out PortConnector base class

The base class to derive subclasses for OutPort's Push/Pull Connectors

Nested Class Summary

Nested classes/interfaces inherited from class jp.go.aist.rtm.RTC.port.ConnectorBase

ConnectorBase.ConnectorInfo, ConnectorBase.ConnectorInfoHolder

Field Summary

Fields

Modifier and Type	Field and Description
protected InPortBase	m_directInPort InProt pointer to the peer in the same process
protected boolean	m_directMode
protected ConnectorListeners	m_inPortListeners A pointer to a InPort's ConnectorListener
protected boolean	m_isLittleEndian
protected ConnectorListeners	m_listeners A reference to a ConnectorListener
protected ConnectorBase.ConnectorInfo	m_profile
protected Logbuf	rtcout

Constructor Summary

Constructors

Constructor and Description
OutPortConnector(ConnectorBase.ConnectorInfo profile, ConnectorListeners listeners) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	directMode() Returns direct connection mode
abstract ReturnCode	disconnect() Disconnect connection
abstract BufferBase<org.omg.CORBA.portable.OutputStream>	getBuffer() Getting Buffer
java.lang.String	id() Getting Connector ID
boolean	isLittleEndian() Returns endian information
java.lang.String	name() Getting Connector name
ConnectorBase.ConnectorInfo	profile() Getting Profile
void	setDirectMode() Setting a direct mode
void	setEndian(boolean isLittleEndian) Setting an endian type
boolean	setInPort(InPortBase directInPort) Sets the object of InPort
abstract void	setOutPortBase(OutPortBase outportbase) Stores OutPortBase.
abstract <DataType> ReturnCode	write(DataType data) Writes data

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

activate, deactivate

Methods inherited from class java.lang.Object

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

Field Detail

rtcout

protected Logbuf rtcout

m_profile

protected ConnectorBase.ConnectorInfo m_profile

m_isLittleEndian

protected boolean m_isLittleEndian

m_directMode

protected boolean m_directMode

m_directInPort

protected InPortBase m_directInPort

InProt pointer to the peer in the same process

m_listeners

protected ConnectorListeners m_listeners

A reference to a ConnectorListener

m_inPortListeners

protected ConnectorListeners m_inPortListeners

A pointer to a InPort's ConnectorListener

Constructor Detail

OutPortConnector

public OutPortConnector(ConnectorBase.ConnectorInfo profile,
                        ConnectorListeners listeners)

Constructor

Parameters:

profile - ConnectorInfo object which includes connection information

Method Detail

profile

public final ConnectorBase.ConnectorInfo profile()

Getting Profile

This operation returns Connector Profile

Specified by:

profile in class ConnectorBase

id

public final java.lang.String id()

Getting Connector ID

This operation returns Connector ID

Specified by:

id in class ConnectorBase

name

public final java.lang.String name()

Getting Connector name

This operation returns Connector name

Specified by:

name in class ConnectorBase

setDirectMode

public void setDirectMode()

Setting a direct mode

This operation set this connector's direct mode

directMode

public boolean directMode()

Returns direct connection mode

This value is true if the architecture is direct connection.

Returns:

Returns the direct mode setting.

setEndian

public void setEndian(boolean isLittleEndian)

Setting an endian type

This operation set this connector's endian type

isLittleEndian

public boolean isLittleEndian()

Returns endian information

This value is true if the architecture is little-endian; false if it is big-endian.

Returns:

Returns the endian setting.

disconnect

public abstract ReturnCode disconnect()

Disconnect connection

This operation disconnect this connection

Specified by:

disconnect in class ConnectorBase

Returns:

ReturnCode

getBuffer

public abstract BufferBase<org.omg.CORBA.portable.OutputStream> getBuffer()

Getting Buffer

This operation returns this connector's buffer

Specified by:

getBuffer in class ConnectorBase

Returns:

A pointer to the buffer owned by this connector

write

public abstract <DataType> ReturnCode write(DataType data)

Writes data

The write function to write data from OutPort to Buffer

setInPort

public boolean setInPort(InPortBase directInPort)

Sets the object of InPort

Set an object of InPortBase for a direct port.

Parameters:

directInPort - InPortBase object

setOutPortBase

public abstract void setOutPortBase(OutPortBase outportbase)

Stores OutPortBase.

Parameters:

outportbase - OutPortBase