OpenRTM-aist-Python 2.0.0
|
Public Member Functions | |
def | __init__ (self) |
def | __del__ (self) |
def | init (self, prop) |
def | setConsumer (self, consumer) |
def | setBuffer (self, buffer) |
def | setListener (self, info, listeners) |
def | write (self, data, sec, usec) |
def | isActive (self) |
def | activate (self) |
def | deactivate (self) |
def | onSend (self, data) |
def | onReceived (self, data) |
def | onReceiverFull (self, data) |
def | onReceiverTimeout (self, data) |
def | onReceiverError (self, data) |
Public Member Functions inherited from OpenRTM_aist.PublisherBase.PublisherBase | |
def | init (self, prop) |
def | release (self) |
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
def | toString (status) |
Additional Inherited Members | |
Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
int | PORT_OK = 0 |
PublisherFlush class
def OpenRTM_aist.PublisherFlush.PublisherFlush.__init__ | ( | self | ) |
Constructor
Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.
def OpenRTM_aist.PublisherFlush.PublisherFlush.__del__ | ( | self | ) |
Destructor
def OpenRTM_aist.PublisherFlush.PublisherFlush.activate | ( | self | ) |
activation
This function activates the publisher. By calling this function, this publisher starts the thread that pushes data to InPort. If precondition such as initialization process and so on is not met, the error code PRECONDITION_NOT_MET is returned.
PublisherBase::ReturnCode PublisherFlush::activate()
Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.
def OpenRTM_aist.PublisherFlush.PublisherFlush.deactivate | ( | self | ) |
deactivation
This function deactivates the publisher. By calling this function, this publisher stops the thread that pushes data to InPort. If precondition such as initialization process and so on is not met, the error code PRECONDITION_NOT_MET is returned.
PublisherBase::ReturnCode PublisherFlush::deactivate()
Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.
def OpenRTM_aist.PublisherFlush.PublisherFlush.init | ( | self, | |
prop | |||
) |
initialization
This function have to be called before using this class object. However, this PublisherFlush class has no parameters to be initialized.
property | Property objects that includes the control information of this Publisher |
virtual ReturnCode init(coil::Properties& prop);
Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.
def OpenRTM_aist.PublisherFlush.PublisherFlush.isActive | ( | self | ) |
If publisher is active state
A Publisher can be activated/deactivated synchronized with the data port. The active state and the non-active state are made transition by the "activate()" and the "deactivate()" functions respectively. This function confirms if the publisher is in active state.
bool PublisherFlush::isActive()
Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.
def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceived | ( | self, | |
data | |||
) |
Notify an ON_RECEIVED event to listeners
data | cdrMemoryStream |
inline void onReceived(const cdrMemoryStream& data)
def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverError | ( | self, | |
data | |||
) |
Notify an ON_RECEIVER_ERROR event to listeners
data | cdrMemoryStream |
inline void onReceiverError(const cdrMemoryStream& data)
def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverFull | ( | self, | |
data | |||
) |
Notify an ON_RECEIVER_FULL event to listeners
data | cdrMemoryStream |
inline void onReceiverFull(const cdrMemoryStream& data)
def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverTimeout | ( | self, | |
data | |||
) |
Notify an ON_RECEIVER_TIMEOUT event to listeners
data | cdrMemoryStream |
inline void onReceiverTimeout(const cdrMemoryStream& data)
def OpenRTM_aist.PublisherFlush.PublisherFlush.onSend | ( | self, | |
data | |||
) |
Notify an ON_SEND event to listners
data | cdrMemoryStream |
inline void onSend(const cdrMemoryStream& data)
def OpenRTM_aist.PublisherFlush.PublisherFlush.setBuffer | ( | self, | |
buffer | |||
) |
Setting buffer pointer
Since PublisherFlush does not use any buffers, This function always returns PORT_OK.
buffer | CDR buffer |
PublisherBase::ReturnCode PublisherFlush::setBuffer(CdrBufferBase* buffer)
Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.
def OpenRTM_aist.PublisherFlush.PublisherFlush.setConsumer | ( | self, | |
consumer | |||
) |
Store InPort consumer
This operation sets a consumer that is associated with this object. If the consumer object is NULL, INVALID_ARGS will be returned.
consumer | A pointer to a consumer object. |
PublisherFlush::setConsumer(InPortConsumer* consumer)
Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.
def OpenRTM_aist.PublisherFlush.PublisherFlush.setListener | ( | self, | |
info, | |||
listeners | |||
) |
Set the listener.
This function sets ConnectorListeners listener object to the Publisher. By setting ConnectorListeners containing various listeners objects, these listeners are called at the time of reading and writing of a buffer, and transmission of data etc. Since the ownership of the ConnectorListeners object is owned by Port or RTObject, the Publisher never deletes the ConnectorListeners object. If the given ConnectorListeners' pointer is NULL, this function returns INVALID_ARGS.
info | ConnectorInfo that is localized object of ConnectorProfile |
listeners | ConnectorListeners that holds various listeners |
virtual ::RTC::DataPortStatus::Enum setListener(ConnectorInfo& info, RTC::ConnectorListeners* listeners);
Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.
def OpenRTM_aist.PublisherFlush.PublisherFlush.write | ( | self, | |
data, | |||
sec, | |||
usec | |||
) |
Write data
This function writes data into the consumer associated with this Publisher. If this function is called without initializing correctly such as a consumer, listeners, etc., error code PRECONDITION_NOT_MET will be returned and no operation of the writing to the consumer etc. will be performed.
When publisher writes data to the buffer, if the consumer returns full-status, returns error, is returned with timeout, error codes BUFFER_FULL, BUFFER_ERROR and BUFFER_TIMEOUT will be returned respectively.
In other cases, PROT_ERROR will be returned.
data | Data to be wrote to the buffer |
sec | Timeout time in unit seconds |
nsec | Timeout time in unit nano-seconds |
PublisherBase::ReturnCode PublisherFlush::write(const cdrMemoryStream& data, unsigned long sec, unsigned long usec)
Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.