Public Member Functions | List of all members
OpenRTM_aist.PublisherBase.PublisherBase Class Reference

Base class of Publisher. More...

Inheritance diagram for OpenRTM_aist.PublisherBase.PublisherBase:
Inheritance graph
[legend]

Public Member Functions

def activate (self)
 virtual ReturnCode activate() = 0; More...
 
def deactivate (self)
 virtual ReturnCode deactivate() = 0; More...
 
def init (self, prop)
 Initializing configuration. More...
 
def isActive (self)
 virtual bool isActive() = 0; More...
 
def release (self)
 Release the Publisher. More...
 
def setBuffer (self, buffer)
 virtual ReturnCode setBuffer(BufferBase<cdrMemoryStream>* buffer) = 0; More...
 
def setConsumer (self, consumer)
 virtual ReturnCode setConsumer(InPortConsumer* consumer) = 0; More...
 
def setListener (self, info, listeners)
 
def write (self, data, sec, usec)
 
- Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def __init__ (self)
 
def toString (status)
 Convert DataPortStatus into the string. More...
 

Additional Inherited Members

- Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int BUFFER_EMPTY = 4
 
int BUFFER_ERROR = 2
 
int BUFFER_FULL = 3
 
int BUFFER_TIMEOUT = 5
 
int CONNECTION_LOST = 12
 
int INVALID_ARGS = 10
 
int PORT_ERROR = 1
 
int PORT_OK = 0
 DataPortStatus return codes. More...
 
int PRECONDITION_NOT_MET = 11
 
int RECV_EMPTY = 8
 
int RECV_TIMEOUT = 9
 
int SEND_FULL = 6
 
int SEND_TIMEOUT = 7
 
 toString = staticmethod(toString)
 
int UNKNOWN_ERROR = 13
 

Detailed Description

Base class of Publisher.

A base class of Publisher*. Variation of Publisher* which implements details of Publisher inherits this PublisherBase class.

Definition at line 44 of file PublisherBase.py.

Member Function Documentation

◆ activate()

def OpenRTM_aist.PublisherBase.PublisherBase.activate (   self)

virtual ReturnCode activate() = 0;

Definition at line 103 of file PublisherBase.py.

◆ deactivate()

def OpenRTM_aist.PublisherBase.PublisherBase.deactivate (   self)

virtual ReturnCode deactivate() = 0;

Definition at line 107 of file PublisherBase.py.

◆ init()

def OpenRTM_aist.PublisherBase.PublisherBase.init (   self,
  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.

Parameters
propConfiguration information

virtual ReturnCode init(coil::Properties& prop) = 0;

Definition at line 76 of file PublisherBase.py.

◆ isActive()

def OpenRTM_aist.PublisherBase.PublisherBase.isActive (   self)

virtual bool isActive() = 0;

Definition at line 99 of file PublisherBase.py.

◆ release()

def OpenRTM_aist.PublisherBase.PublisherBase.release (   self)

Release the Publisher.

Release this Publisher. When Publisher becomes unnecessary, this is invoked from PublisherFactory.

virtual void release(){}

Definition at line 130 of file PublisherBase.py.

◆ setBuffer()

def OpenRTM_aist.PublisherBase.PublisherBase.setBuffer (   self,
  buffer 
)

virtual ReturnCode setBuffer(BufferBase<cdrMemoryStream>* buffer) = 0;

Definition at line 84 of file PublisherBase.py.

◆ setConsumer()

def OpenRTM_aist.PublisherBase.PublisherBase.setConsumer (   self,
  consumer 
)

virtual ReturnCode setConsumer(InPortConsumer* consumer) = 0;

Definition at line 80 of file PublisherBase.py.

◆ setListener()

def OpenRTM_aist.PublisherBase.PublisherBase.setListener (   self,
  info,
  listeners 
)

Definition at line 89 of file PublisherBase.py.

◆ write()

def OpenRTM_aist.PublisherBase.PublisherBase.write (   self,
  data,
  sec,
  usec 
)

Definition at line 95 of file PublisherBase.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:09