Base class of Publisher. More...
Public Member Functions | |
| def | activate |
| virtual ReturnCode activate() = 0; | |
| def | deactivate |
| virtual ReturnCode deactivate() = 0; | |
| def | init |
| Initializing configuration. | |
| def | isActive |
| virtual bool isActive() = 0; | |
| def | release |
| Release the Publisher. | |
| def | setBuffer |
| virtual ReturnCode setBuffer(BufferBase<cdrMemoryStream>* buffer) = 0; | |
| def | setConsumer |
| virtual ReturnCode setConsumer(InPortConsumer* consumer) = 0; | |
| def | setListener |
| def | write |
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
virtual ReturnCode activate() = 0;
Reimplemented in OpenRTM_aist.PublisherPeriodic.PublisherPeriodic, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherFlush.PublisherFlush.
Definition at line 103 of file PublisherBase.py.
virtual ReturnCode deactivate() = 0;
Reimplemented in OpenRTM_aist.PublisherPeriodic.PublisherPeriodic, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherFlush.PublisherFlush.
Definition at line 107 of file PublisherBase.py.
| 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.PublisherPeriodic.PublisherPeriodic, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherFlush.PublisherFlush.
Definition at line 76 of file PublisherBase.py.
virtual bool isActive() = 0;
Reimplemented in OpenRTM_aist.PublisherPeriodic.PublisherPeriodic, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherFlush.PublisherFlush.
Definition at line 99 of file PublisherBase.py.
| 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.
| def OpenRTM_aist.PublisherBase.PublisherBase.setBuffer | ( | self, | |
| buffer | |||
| ) |
virtual ReturnCode setBuffer(BufferBase<cdrMemoryStream>* buffer) = 0;
Reimplemented in OpenRTM_aist.PublisherPeriodic.PublisherPeriodic, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherFlush.PublisherFlush.
Definition at line 84 of file PublisherBase.py.
| def OpenRTM_aist.PublisherBase.PublisherBase.setConsumer | ( | self, | |
| consumer | |||
| ) |
virtual ReturnCode setConsumer(InPortConsumer* consumer) = 0;
Reimplemented in OpenRTM_aist.PublisherPeriodic.PublisherPeriodic, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherFlush.PublisherFlush.
Definition at line 80 of file PublisherBase.py.
| def OpenRTM_aist.PublisherBase.PublisherBase.setListener | ( | self, | |
| info, | |||
| listeners | |||
| ) |
Reimplemented in OpenRTM_aist.PublisherPeriodic.PublisherPeriodic, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherFlush.PublisherFlush.
Definition at line 89 of file PublisherBase.py.
| def OpenRTM_aist.PublisherBase.PublisherBase.write | ( | self, | |
| data, | |||
| sec, | |||
| usec | |||
| ) |
Reimplemented in OpenRTM_aist.PublisherPeriodic.PublisherPeriodic, OpenRTM_aist.PublisherNew.PublisherNew, and OpenRTM_aist.PublisherFlush.PublisherFlush.
Definition at line 95 of file PublisherBase.py.
The documentation for this class was generated from the following file: