OpenRTM-aist  1.2.1
Public Member Functions | List of all members
RTC::OutPortSHMProvider Class Reference

OutPortSHMProvider class. More...

#include <OutPortSHMProvider.h>

Inheritance diagram for RTC::OutPortSHMProvider:
Inheritance graph
[legend]
Collaboration diagram for RTC::OutPortSHMProvider:
Collaboration graph
[legend]

Public Member Functions

 OutPortSHMProvider ()
 Constructor. More...
 
virtual ~OutPortSHMProvider ()
 Destructor. More...
 
virtual void init (coil::Properties &prop)
 Initializing configuration. More...
 
virtual void setBuffer (CdrBufferBase *buffer)
 Setting outside buffer's pointer. More...
 
virtual void setListener (ConnectorInfo &info, ConnectorListeners *listeners)
 Set the listener. More...
 
virtual void setConnector (OutPortConnector *connector)
 set Connector More...
 
virtual ::OpenRTM::PortStatus get () throw (CORBA::SystemException)
 [CORBA interface] Get data from the buffer More...
 
- Public Member Functions inherited from RTC::OutPortProvider
virtual DATAPORTSTATUS_ENUM ~OutPortProvider (void)
 Destructor. More...
 
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information. More...
 
virtual bool publishInterface (SDOPackage::NVList &properties)
 Publish interface information. More...
 
- Public Member Functions inherited from RTC::SharedMemoryPort
 SharedMemoryPort ()
 Constructor. More...
 
virtual ~SharedMemoryPort ()
 Destructor. More...
 
virtual int string_to_MemorySize (std::string size_str)
 
virtual void create_memory (::CORBA::ULongLong memory_size, const char *shm_address) throw (CORBA::SystemException)
 
virtual void open_memory (::CORBA::ULongLong memory_size, const char *shm_address) throw (CORBA::SystemException)
 
virtual void close_memory (::CORBA::Boolean unlink=false) throw (CORBA::SystemException)
 
virtual void write (cdrMemoryStream &data)
 
virtual void read (cdrMemoryStream &data)
 
virtual void setInterface (::OpenRTM::PortSharedMemory_ptr sm) throw (CORBA::SystemException)
 
virtual void setEndian (::CORBA::Boolean endian) throw (CORBA::SystemException)
 
virtual ::OpenRTM::PortStatus put () throw (CORBA::SystemException)
 
virtual ::OpenRTM::PortStatus get () throw (CORBA::SystemException)
 
virtual ::OpenRTM::PortSharedMemory_ptr getObjRef ()
 

Additional Inherited Members

- Public Types inherited from RTC::DataPortStatus
enum  Enum {
  PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL,
  BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT,
  RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET,
  CONNECTION_LOST, UNKNOWN_ERROR
}
 DataPortStatus return codes. More...
 
- Static Public Member Functions inherited from RTC::DataPortStatus
static const char * toString (DataPortStatus::Enum status)
 Convert DataPortStatus into the string. More...
 
- Protected Member Functions inherited from RTC::OutPortProvider
void setPortType (const char *port_type)
 Set the port type. More...
 
void setDataType (const char *data_type)
 Set the data type. More...
 
void setInterfaceType (const char *interface_type)
 Set the interface type. More...
 
void setDataFlowType (const char *dataflow_type)
 Set the data flow type. More...
 
void setSubscriptionType (const char *subs_type)
 Set the subscription type. More...
 
- Protected Attributes inherited from RTC::OutPortProvider
SDOPackage::NVList m_properties
 Properties to hold the port profiles. More...
 
Logger rtclog
 Logger stream. More...
 
- Protected Attributes inherited from RTC::SharedMemoryPort
::OpenRTM::PortSharedMemory_var m_smInterface
 
bool m_endian
 
coil::SharedMemory m_shmem
 

Detailed Description

OutPortSHMProvider class.

Since
1.2.0

Constructor & Destructor Documentation

RTC::OutPortSHMProvider::OutPortSHMProvider ( )

Constructor.

Constructor

virtual RTC::OutPortSHMProvider::~OutPortSHMProvider ( )
virtual

Destructor.

Destructor

Member Function Documentation

virtual ::OpenRTM::PortStatus RTC::OutPortSHMProvider::get ( )
throw (CORBA::SystemException
)

[CORBA interface] Get data from the buffer

Get data from the internal buffer.

Returns
Data got from the buffer.
virtual void RTC::OutPortSHMProvider::init ( coil::Properties prop)
virtual

Initializing configuration.

Parameters
propConfiguration information

Reimplemented from RTC::OutPortProvider.

virtual void RTC::OutPortSHMProvider::setBuffer ( CdrBufferBase buffer)
virtual

Setting outside buffer's pointer.

Parameters
bufferA pointer to a data buffer to be used by OutPortProvider

Implements RTC::OutPortProvider.

virtual void RTC::OutPortSHMProvider::setConnector ( OutPortConnector connector)
virtual

set Connector

Parameters
connectorOutPortConnector

Implements RTC::OutPortProvider.

virtual void RTC::OutPortSHMProvider::setListener ( ConnectorInfo info,
ConnectorListeners listeners 
)
virtual

Set the listener.

Parameters
infoConnector information
listenersListener objects

Implements RTC::OutPortProvider.


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