OpenRTM-aist-Python 1.1.2
Public Member Functions | List of all members
OpenRTM_aist.InPort.InPort Class Reference

InPort template class. More...

Inheritance diagram for OpenRTM_aist.InPort.InPort:
OpenRTM_aist.InPortBase.InPortBase OpenRTM_aist.PortBase.PortBase OpenRTM_aist.DataPortStatus.DataPortStatus

Public Member Functions

def __init__
 A constructor. More...
 
def name
 const char* name()
 
def isNew
 bool isNew()
 
def isEmpty
 Check whether the data is newest. More...
 
def read
 Readout the value from DataPort. More...
 
def update
 Read into bound T-type data from current InPort. More...
 
- Public Member Functions inherited from OpenRTM_aist.InPortBase.InPortBase
def __init__
 Constructor. More...
 
def __del__
 Destructor. More...
 
def init
 Initializing properties. More...
 
def read
 It is a virtual method that is called from RTObject_impl::readAll(). More...
 
def properties
 Get properties. More...
 
def connectors
 Connector list. More...
 
def getConnectorProfiles
 ConnectorProfile list. More...
 
def getConnectorIds
 ConnectorId list. More...
 
def getConnectorNames
 Connector name list. More...
 
def getConnectorById
 Getting ConnectorProfile by ID. More...
 
def getConnectorByName
 Getting Connector by name. More...
 
def getConnectorProfileById
 Getting ConnectorProfile by name. More...
 
def getConnectorProfileByName
 Getting ConnectorProfile by name. More...
 
def connect
 [CORBA interface] Connect the Port More...
 
def activateInterfaces
 Activate all Port interfaces. More...
 
def deactivateInterfaces
 Deactivate all Port interfaces. More...
 
def addConnectorDataListener
 Adding BufferDataListener type listener. More...
 
def removeConnectorDataListener
 Removing BufferDataListener type listener. More...
 
def addConnectorListener
 Adding ConnectorListener type listener. More...
 
def removeConnectorListener
 Removing BufferDataListener type listener. More...
 
def publishInterfaces
 Publish interface information. More...
 
def subscribeInterfaces
 Subscribe to the interface. More...
 
def unsubscribeInterfaces
 Disconnect the interface connection. More...
 
def initProviders
 InPort provider initializationvoid initProviders();.
 
def initConsumers
 OutPort consumer initializationvoid initConsumers();.
 
def createProvider
 InPort provider creationInPortProvider* createProvider(ConnectorProfile& cprof, coil::Properties& prop);.
 
def createConsumer
 InPort provider creationOutPortConsumer* createConsumer(const ConnectorProfile& cprof, coil::Properties& prop);.
 
def createConnector
 InPortPushConnector creationInPortConnector* createConnector(ConnectorProfile& cprof, coil::Properties& prop, InPortProvider* provider);.
 
- Public Member Functions inherited from OpenRTM_aist.PortBase.PortBase
def __init__
 Constructor. More...
 
def __del__
 Destructor. More...
 
def get_port_profile
 [CORBA interface] Get the PortProfile of the Port More...
 
def getPortProfile
 Get the PortProfile of the Port. More...
 
def get_connector_profiles
 [CORBA interface] Get the ConnectorProfileList of the Port More...
 
def get_connector_profile
 [CORBA interface] Get the ConnectorProfile More...
 
def connect
 [CORBA interface] Connect the Port More...
 
def notify_connect
 [CORBA interface] Notify the Ports connection More...
 
def disconnect
 [CORBA interface] Disconnect the Port More...
 
def notify_disconnect
 [CORBA interface] Notify the Ports disconnection More...
 
def disconnect_all
 [CORBA interface] Connect the Port More...
 
def setName
 Set the name of this Port. More...
 
def getName
 Get the name of this Port. More...
 
def getProfile
 Get the PortProfile of the Port. More...
 
def setPortRef
 Set the object reference of this Port. More...
 
def getPortRef
 Get the object reference of this Port. More...
 
def setOwner
 Set the owner RTObject of the Port. More...
 
def setOnPublishInterfaces
 Setting callback called on publish interfaces. More...
 
def setOnSubscribeInterfaces
 Setting callback called on publish interfaces. More...
 
def setOnConnected
 Setting callback called on connection established. More...
 
def setOnUnsubscribeInterfaces
 Setting callback called on unsubscribe interfaces. More...
 
def setOnDisconnected
 Setting callback called on disconnected. More...
 
def setPortConnectListenerHolder
 Setting PortConnectListener holder. More...
 
def publishInterfaces
 Publish interface information. More...
 
def connectNext
 Call notify_connect() of the next Port. More...
 
def disconnectNext
 Call notify_disconnect() of the next Port. More...
 
def subscribeInterfaces
 Publish interface information. More...
 
def unsubscribeInterfaces
 Disconnect interface connection. More...
 
def setConnectionLimit
 Set the maximum number of connections. More...
 
def isEmptyId
 Whether connector_id of ConnectorProfile is empty. More...
 
def getUUID
 Get the UUID. More...
 
def setUUID
 Create and set the UUID to the ConnectorProfile. More...
 
def isExistingConnId
 Whether the given id exists in stored ConnectorProfiles. More...
 
def findConnProfile
 Find ConnectorProfile with id. More...
 
def findConnProfileIndex
 Find ConnectorProfile with id. More...
 
def updateConnectorProfile
 Append or update the ConnectorProfile list. More...
 
def eraseConnectorProfile
 Delete the ConnectorProfile. More...
 
def appendInterface
 Append an interface to the PortInterfaceProfile. More...
 
def deleteInterface
 Delete an interface from the PortInterfaceProfile. More...
 
def addProperty
 Add NameValue data to PortProfile's properties. More...
 
def appendProperty
 Append NameValue data to PortProfile's properties. More...
 
def updateConnectors
 Disconnect ports that doesn't exist. More...
 
def checkPorts
 Existence of ports. More...
 
- Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def toString
 Convert DataPortStatus into the string. More...
 

Additional Inherited Members

- Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int PORT_OK = 0
 DataPortStatus return codes. More...
 

Detailed Description

InPort template class.

This class template provides interfaces to input port. Component developer can define input value, which act as input port from other components, using this template. This is class template. This class have to be incarnated class as port value types. This value types are previously define RtComponent IDL. ex. type T: TimedFload, TimedLong etc...

Since
0.2.0

Constructor & Destructor Documentation

def OpenRTM_aist.InPort.InPort.__init__ (   self,
  name,
  value,
  buffer = None,
  read_block = False,
  write_block = False,
  read_timeout = 0,
  write_timeout = 0 
)

A constructor.

Setting channel name and registering channel value.

Parameters
self
nameA name of the InPort. This name is referred by InPortBase::name().
valueA channel value related with the channel.
read_block
write_block
read_timeout
write_timeout

Member Function Documentation

def OpenRTM_aist.InPort.InPort.isEmpty (   self)

Check whether the data is newest.

Check whether the data stored at a current buffer position is newest.

Returns
Newest data check result ( true:Newest data. Data has not been readout yet. false:Past data¡¥Data has already been readout.)

bool isEmpty()

def OpenRTM_aist.InPort.InPort.read (   self)

Readout the value from DataPort.

Readout the value from DataPort

  • When Callback functor OnRead is already set, OnRead will be invoked before reading from the buffer held by DataPort.
  • When the buffer held by DataPort can detect the underflow, and when it detected the underflow at reading, callback functor OnUnderflow will be invoked.
  • When callback functor OnReadConvert is already set, the return value of operator() of OnReadConvert will be the return value of read().
  • When timeout of reading is already set by setReadTimeout(), it waits for only timeout time until the state of the buffer underflow is reset, and if OnUnderflow is already set, this will be invoked to return.
Returns
Readout data

DataType read()

def OpenRTM_aist.InPort.InPort.update (   self)

Read into bound T-type data from current InPort.


The documentation for this class was generated from the following file: