YARP  2.3.68+220-20170323.2+git4955ef0
Yet Another Robot Platform
yarp::os::PortReader Class Referenceabstract

Interface implemented by all objects that can read themselves from the network, such as Bottle objects. More...

#include <yarp/os/PortReader.h>

+ Inheritance diagram for yarp::os::PortReader:

Public Member Functions

virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType ()
 

Detailed Description

Interface implemented by all objects that can read themselves from the network, such as Bottle objects.

See also
Port, PortWriter
Examples:
port_power/ex0300_port_callback.cpp, port_power/ex0402_port_callback_reply.cpp, and port_power/ex0403_bufferedport_callback_reply.cpp.

Definition at line 25 of file PortReader.h.

Constructor & Destructor Documentation

◆ ~PortReader()

yarp::os::PortReader::~PortReader ( )
virtual

Destructor.

Definition at line 10 of file PortReader.cpp.

Member Function Documentation

◆ getReadType()

virtual Type yarp::os::PortReader::getReadType ( )
inlinevirtual

Reimplemented in yarp::sig::Image.

Definition at line 41 of file PortReader.h.

◆ read()

virtual bool yarp::os::PortReader::read ( ConnectionReader reader)
pure virtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implemented in jointData::Editor, yarp::os::impl::BottleImpl, yarp::sig::Vector, yarp::os::Property, yarp::sig::Matrix, yarp::os::impl::PortCore, yarp::os::Bottle, yarp::sig::Image, yarp::os::Value, yarp::os::Node::Helper, visualization_msgs_Marker, visualization_msgs_Marker, yarp::dev::DeviceResponder, yarp::dev::ServerInertial, sensor_msgs_CameraInfo, yarp::dev::ServerSoundGrabber, sensor_msgs_LaserScan, RFModuleRespondHandler, sensor_msgs_Imu, sensor_msgs_JointState, yarp::os::ManagedBytes, sensor_msgs_PointCloud2, sensor_msgs_Image, yarp::math::Quaternion, PingSampler, yarp::sig::Sound, jointData, yarp::os::Stamp, sensor_msgs_PointField, yarp::os::impl::Storable, sensor_msgs_RegionOfInterest, yarp::os::impl::PortCoreAdapter, std_msgs_Header, yarp::dev::LocationsServer, std_msgs_ColorRGBA, std_msgs_ColorRGBA, geometry_msgs_TransformStamped, yarp::os::PortablePair< HEAD, BODY >, geometry_msgs_Quaternion, geometry_msgs_Vector3, RosSlave, geometry_msgs_Point, geometry_msgs_Point, visualization_msgs_MarkerArray, visualization_msgs_MarkerArray, yarp::sig::VectorBase, tf_tfMessage, geometry_msgs_Transform, geometry_msgs_Wrench, geometry_msgs_WrenchStamped, TickDuration, geometry_msgs_Pose, geometry_msgs_Pose, yarp::os::idl::UnwrappedView< T >, yarp::os::impl::PortCommand, ModuleHelper, TickTime, yarp::name::NameServerConnectionHandler, yarp::os::BinPortable< T >, yarp::os::SystemInfoSerializer, yarp::os::NetworkClock, yarp::os::Portable, and yarp::os::idl::Unwrapped< T >.


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