OpenRTM_aist.PublisherBase.PublisherBase Class Reference
Base class of Publisher. More...
Public Member Functions | |
| def | init |
| Initializing configuration. | |
| def | setConsumer |
| virtual ReturnCode setConsumer(InPortConsumer* consumer) = 0; | |
| def | setBuffer |
| virtual ReturnCode setBuffer(BufferBase<cdrMemoryStream>* buffer) = 0; | |
| def | isActive |
| virtual bool isActive() = 0; | |
| def | activate |
| virtual ReturnCode activate() = 0; | |
| def | deactivate |
| virtual ReturnCode deactivate() = 0; | |
| def | release |
| Release the Publisher. | |
Detailed Description
Base class of Publisher.
A base class of Publisher*. Variation of Publisher* which implements details of Publisher inherits this PublisherBase class.
Member Function Documentation
| 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:
-
prop Configuration information
virtual ReturnCode init(coil.Properties& prop) = 0;
Reimplemented in OpenRTM_aist.PublisherFlush.PublisherFlush, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherPeriodic.PublisherPeriodic.
| 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(){}
The documentation for this class was generated from the following file:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/PublisherBase.py
