OpenRTM_aist.InPort.InPort Class Reference
InPort template class. More...
Public Member Functions | |
| def | __init__ |
| A constructor. | |
| def | __del__ |
| Destructor. | |
| def | name |
| const char* name() | |
| def | isNew |
| bool isNew() | |
| def | isEmpty |
| Check whether the data is newest. | |
| def | read |
| Readout the value from DataPort. | |
| def | update |
| Read into bound T-type data from current InPort. | |
Detailed Description
InPort template class.
This class template provides interfaces to input port. Component developer can define input value, which act as input port from other components, using this template. This is class template. This class have to be incarnated class as port value types. This value types are previously define RtComponent IDL. ex. type T: TimedFload, TimedLong etc...
- Since:
- 0.2.0
Member Function Documentation
| def OpenRTM_aist.InPort.InPort.__del__ | ( | self, | ||
PortBase = OpenRTM_aist.InPortBase | ||||
| ) |
| def OpenRTM_aist.InPort.InPort.__init__ | ( | self, | ||
| name, | ||||
| value, | ||||
buffer = None, |
||||
read_block = False, |
||||
write_block = False, |
||||
read_timeout = 0, |
||||
write_timeout = 0 | ||||
| ) |
A constructor.
Setting channel name and registering channel value.
- Parameters:
-
self name A name of the InPort. This name is referred by InPortBase.name(). value A channel value related with the channel. read_block write_block read_timeout write_timeout
| def OpenRTM_aist.InPort.InPort.isEmpty | ( | self | ) |
Check whether the data is newest.
Check whether the data stored at a current buffer position is newest.
- Returns:
- Newest data check result ( true:Newest data. Data has not been readout yet. false:Past data¡¥Data has already been readout.)
bool isEmpty()
| def OpenRTM_aist.InPort.InPort.read | ( | self | ) |
Readout the value from DataPort.
Readout the value from DataPort
- When Callback functor OnRead is already set, OnRead will be invoked before reading from the buffer held by DataPort.
- When the buffer held by DataPort can detect the underflow, and when it detected the underflow at reading, callback functor OnUnderflow will be invoked.
- When callback functor OnReadConvert is already set, the return value of operator() of OnReadConvert will be the return value of read().
- When timeout of reading is already set by setReadTimeout(), it waits for only timeout time until the state of the buffer underflow is reset, and if OnUnderflow is already set, this will be invoked to return.
- Returns:
- Readout data
DataType read()
Reimplemented from OpenRTM_aist.InPortBase.InPortBase.
| def OpenRTM_aist.InPort.InPort.update | ( | self | ) |
Read into bound T-type data from current InPort.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/InPort.py
