YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::os::TypedReader< T > Class Template Referenceabstract

A base class for sources of typed data. More...

#include <yarp/os/TypedReader.h>

Inherited by yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< DepthImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::BufferedPort< T >, and yarp::os::impl::PortReaderBuffer< T >.

Public Member Functions

virtual void setStrict (bool strict=true)=0
 Call this to strictly keep all messages, or allow old ones to be quietly dropped.
 
virtual T * read (bool shouldWait=true)=0
 Read an available object from the port.
 
virtual void interrupt ()=0
 Abort any read operation currently in progress.
 
virtual T * lastRead ()=0
 Get the last data returned by read()
 
virtual bool isClosed ()=0
 Returns whether the port associated with this reader has been closed.
 
virtual void useCallback (TypedReaderCallback< T > &callback)=0
 Set an object whose onRead method will be called when data is available.
 
virtual void disableCallback ()=0
 Remove a callback set up with useCallback()
 
virtual int getPendingReads ()=0
 Check how many messages are waiting to be read.
 
virtual ~TypedReader ()=default
 Destructor.
 
virtual std::string getName () const =0
 Get name of port being read from.
 
virtual void setReplier (PortReader &reader)=0
 If a message is received that requires a reply, use this handler.
 
virtual void * acquire ()=0
 Take control of the last object read.
 
virtual void release (void *handle)=0
 Return control to YARP of an object previously taken control of with the acquire() method.
 
virtual void setTargetPeriod (double period)=0
 Try to provide data periodically.
 

Detailed Description

template<class T>
class yarp::os::TypedReader< T >

A base class for sources of typed data.

This could be a BufferedPort.

Definition at line 21 of file TypedReader.h.

Constructor & Destructor Documentation

◆ ~TypedReader()

template<class T >
virtual yarp::os::TypedReader< T >::~TypedReader ( )
virtualdefault

Destructor.

Member Function Documentation

◆ acquire()

template<class T >
virtual void * yarp::os::TypedReader< T >::acquire ( )
pure virtual

Take control of the last object read.

YARP will not reuse that object until it is explicitly released by the user. Be careful - if you acquire objects without releasing, YARP will keep making new ones to store incoming messages. So you need to release all objects you acquire eventually to avoid running out of memory.

Returns
the handle to call release() with in order to give YARP back control of the last object read.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ disableCallback()

template<class T >
virtual void yarp::os::TypedReader< T >::disableCallback ( )
pure virtual

Remove a callback set up with useCallback()

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ getName()

template<class T >
virtual std::string yarp::os::TypedReader< T >::getName ( ) const
pure virtual

Get name of port being read from.

Returns
name of port

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ getPendingReads()

template<class T >
virtual int yarp::os::TypedReader< T >::getPendingReads ( )
pure virtual

Check how many messages are waiting to be read.

Returns
number of pending messages

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ interrupt()

template<class T >
virtual void yarp::os::TypedReader< T >::interrupt ( )
pure virtual

Abort any read operation currently in progress.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ isClosed()

template<class T >
virtual bool yarp::os::TypedReader< T >::isClosed ( )
pure virtual

Returns whether the port associated with this reader has been closed.

Returns
true if Port associated with this reader has been closed

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ lastRead()

template<class T >
virtual T * yarp::os::TypedReader< T >::lastRead ( )
pure virtual

Get the last data returned by read()

Returns
pointer to last data returned by read(), or nullptr on failure.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ read()

template<class T >
virtual T * yarp::os::TypedReader< T >::read ( bool  shouldWait = true)
pure virtual

Read an available object from the port.

Parameters
shouldWaittrue if the method should wait until an object is available, false if the call should return immediately if no message is available
Returns
A pointer to an object read from the port, or nullptr if none is available and waiting was not requested. This object is owned by the communication system and should not be deleted by the user. The object is available to the user until the next call to one of the read methods, after which it should not be accessed again.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ release()

template<class T >
virtual void yarp::os::TypedReader< T >::release ( void *  handle)
pure virtual

Return control to YARP of an object previously taken control of with the acquire() method.

Parameters
handlethe pointer returned by acquire() when control of the object was taken by the user.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ setReplier()

template<class T >
virtual void yarp::os::TypedReader< T >::setReplier ( PortReader &  reader)
pure virtual

If a message is received that requires a reply, use this handler.

No buffering happens.

Parameters
readerthe handler to use

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ setStrict()

template<class T >
virtual void yarp::os::TypedReader< T >::setStrict ( bool  strict = true)
pure virtual

Call this to strictly keep all messages, or allow old ones to be quietly dropped.

If you don't call this, old messages will be quietly dropped.

Parameters
strictTrue to keep all messages until they are read, false to drop old messages when a new one comes in.
Warning
If you can't read them as fast as the come in, watch out.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ setTargetPeriod()

template<class T >
virtual void yarp::os::TypedReader< T >::setTargetPeriod ( double  period)
pure virtual

Try to provide data periodically.

If no new data arrives in a given period, repeat the last data received (if any). Similarly, the port should not pass on data more frequently than the given period.

Parameters
periodtarget period in (fractional) seconds.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.

◆ useCallback()

template<class T >
virtual void yarp::os::TypedReader< T >::useCallback ( TypedReaderCallback< T > &  callback)
pure virtual

Set an object whose onRead method will be called when data is available.

Parameters
callbackthe object whose onRead method will be called with data

Implemented in yarp::os::BufferedPort< DepthImage >, yarp::os::impl::PortReaderBuffer< DepthImage >, yarp::os::BufferedPort< ImageType >, yarp::os::impl::PortReaderBuffer< ImageType >, yarp::os::BufferedPort< return_getAllTransforms >, yarp::os::impl::PortReaderBuffer< return_getAllTransforms >, yarp::os::BufferedPort< T >, yarp::os::impl::PortReaderBuffer< T >, yarp::os::BufferedPort< yarp::dev::AllJoyData >, yarp::os::impl::PortReaderBuffer< yarp::dev::AllJoyData >, yarp::os::BufferedPort< yarp::dev::AxisDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::AxisDataList >, yarp::os::BufferedPort< yarp::dev::BatteryData >, yarp::os::impl::PortReaderBuffer< yarp::dev::BatteryData >, yarp::os::BufferedPort< yarp::dev::ButtonDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::ButtonDataList >, yarp::os::BufferedPort< yarp::dev::CommandMessageData >, yarp::os::impl::PortReaderBuffer< yarp::dev::CommandMessageData >, yarp::os::BufferedPort< yarp::dev::HatsDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::HatsDataList >, yarp::os::BufferedPort< yarp::dev::JointStateData >, yarp::os::impl::PortReaderBuffer< yarp::dev::JointStateData >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::MobileBaseVelocity >, yarp::os::BufferedPort< yarp::dev::Nav2D::Odometry >, yarp::os::impl::PortReaderBuffer< yarp::dev::Nav2D::Odometry >, yarp::os::BufferedPort< yarp::dev::SensorStreamingData >, yarp::os::impl::PortReaderBuffer< yarp::dev::SensorStreamingData >, yarp::os::BufferedPort< yarp::dev::StickDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::StickDataList >, yarp::os::BufferedPort< yarp::dev::TouchesDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TouchesDataList >, yarp::os::BufferedPort< yarp::dev::TrackballDataList >, yarp::os::impl::PortReaderBuffer< yarp::dev::TrackballDataList >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::impl::PortReaderBuffer< yarp::os::Bottle >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::impl::PortReaderBuffer< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::sig::Image >, yarp::os::impl::PortReaderBuffer< yarp::sig::Image >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelBgra > >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::impl::PortReaderBuffer< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::LaserScan2D >, yarp::os::impl::PortReaderBuffer< yarp::sig::LaserScan2D >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::impl::PortReaderBuffer< yarp::sig::Sound >, yarp::os::BufferedPort< yarp::sig::VectorOfDouble >, and yarp::os::impl::PortReaderBuffer< yarp::sig::VectorOfDouble >.


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