YARP
Yet Another Robot Platform
yarp::os::Contactable Class Referenceabstract

An abstract port. More...

#include <yarp/os/Contactable.h>

+ Inheritance diagram for yarp::os::Contactable:

Detailed Description

An abstract port.

Anything that can be expressed via a Contact.

Definition at line 37 of file Contactable.h.

Public Member Functions

virtual ~Contactable ()
 Destructor. More...
 
virtual bool open (const std::string &name)=0
 Start port operation, with a specific name, with automatically-chosen network parameters. More...
 
virtual bool open (const Contact &contact, bool registerName=true)=0
 Start port operation with user-chosen network parameters. More...
 
virtual bool addOutput (const std::string &name)=0
 Add an output connection to the specified port. More...
 
virtual bool addOutput (const std::string &name, const std::string &carrier)=0
 Add an output connection to the specified port, using a specified carrier. More...
 
virtual bool addOutput (const Contact &contact)=0
 Add an output connection to the specified port, using specified network parameters. More...
 
virtual void close ()=0
 Stop port activity. More...
 
virtual void interrupt ()=0
 Interrupt any current reads or writes attached to the port. More...
 
virtual void resume ()=0
 Put the port back in an operative state after interrupt() has been called. More...
 
virtual Contact where () const =0
 Returns information about how this port can be reached. More...
 
virtual std::string getName () const
 Get name of port. More...
 
virtual bool setEnvelope (PortWriter &envelope)=0
 Set an envelope (e.g., a timestamp) to the next message which will be sent. More...
 
virtual bool getEnvelope (PortReader &envelope)=0
 Get the envelope information (e.g., a timestamp) from the last message received on the port. More...
 
virtual int getInputCount ()=0
 Determine how many connections are arriving into this port. More...
 
virtual int getOutputCount ()=0
 Determine how many output connections this port has. More...
 
virtual void getReport (PortReport &reporter)=0
 Get information on the state of the port - connections etc. More...
 
virtual void setReporter (PortReport &reporter)=0
 Set a callback to be called upon any future connections and disconnections to/from the port. More...
 
virtual void resetReporter ()=0
 Remove the callback which is called upon any future connections and disconnections to/from the port. More...
 
virtual bool isWriting ()=0
 Report whether the port is currently writing data. More...
 
virtual void setReader (PortReader &reader)=0
 Set an external reader for port data. More...
 
virtual void setAdminReader (PortReader &reader)=0
 Set an external reader for unrecognized administrative port messages. More...
 
virtual void setInputMode (bool expectInput)=0
 Configure the port to allow or forbid inputs. More...
 
virtual void setOutputMode (bool expectOutput)=0
 Configure the port to allow or forbid outputs. More...
 
virtual void setRpcMode (bool expectRpc)=0
 Configure the port to be RPC only. More...
 
virtual Type getType ()=0
 Get the type of data the port has committed to send/receive. More...
 
virtual void promiseType (const Type &typ)=0
 Commit the port to a particular type of data. More...
 
virtual PropertyacquireProperties (bool readOnly)=0
 Access unstructured port properties. More...
 
virtual void releaseProperties (Property *prop)=0
 End access unstructured port properties. More...
 
virtual void includeNodeInName (bool flag)=0
 Choose whether to prepend a node name (if one is available) to the port's name. More...
 
void setReadOnly ()
 Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(false) More...
 
void setWriteOnly ()
 Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(false) More...
 
void setRpcServer ()
 Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(true) More...
 
void setRpcClient ()
 Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(true) More...
 
virtual bool setCallbackLock (yarp::os::Mutex *mutex)=0
 Add a lock to use when invoking callbacks. More...
 
virtual bool setCallbackLock (std::mutex *mutex=nullptr)=0
 Add a lock to use when invoking callbacks. More...
 
virtual bool removeCallbackLock ()=0
 Remove a lock on callbacks added with setCallbackLock() More...
 
virtual bool lockCallback ()=0
 Lock callbacks until unlockCallback() is called. More...
 
virtual bool tryLockCallback ()=0
 Try to lock callbacks until unlockCallback() is called. More...
 
virtual void unlockCallback ()=0
 Unlock callbacks. More...
 

Constructor & Destructor Documentation

◆ ~Contactable()

yarp::os::Contactable::~Contactable ( )
virtualdefault

Destructor.

Member Function Documentation

◆ acquireProperties()

virtual Property* yarp::os::Contactable::acquireProperties ( bool  readOnly)
pure virtual

Access unstructured port properties.

Parameters
readOnlyset this if you won't be modifying the properties.
Returns
the port properties (or nullptr if readOnly and none have been set)

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ addOutput() [1/3]

virtual bool yarp::os::Contactable::addOutput ( const Contact contact)
pure virtual

Add an output connection to the specified port, using specified network parameters.

Parameters
contactinformation on how to reach the target
Returns
true iff the connection is successfully created

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ addOutput() [2/3]

virtual bool yarp::os::Contactable::addOutput ( const std::string &  name)
pure virtual

Add an output connection to the specified port.

Parameters
namethe name of the target port
Returns
true iff the connection is successfully created

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ addOutput() [3/3]

virtual bool yarp::os::Contactable::addOutput ( const std::string &  name,
const std::string &  carrier 
)
pure virtual

Add an output connection to the specified port, using a specified carrier.

Parameters
namethe name of the target port
carrierthe carrier (network protocol) to use, e.g. "tcp", "udp", "mcast", "text", ...
Returns
true iff the connection is successfully created

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ close()

virtual void yarp::os::Contactable::close ( )
pure virtual

Stop port activity.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, yarp::os::Publisher< T >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::Publisher< ROS_MSG >, yarp::os::Publisher< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::Publisher< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Image >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::Subscriber< T >, yarp::os::Subscriber< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::MapMetaData >, and yarp::os::AbstractContactable.

◆ getEnvelope()

virtual bool yarp::os::Contactable::getEnvelope ( PortReader envelope)
pure virtual

Get the envelope information (e.g., a timestamp) from the last message received on the port.

You must be sure to match the type of your envelope for getEnvelope with whatever is being sent using setEnvelope. The Stamp class is a typical choice for timestamps. The Bottle class also works as an envelope, but it is not specialized to be efficient.

Parameters
enveloperecipient for envelope information for last message received by port.
Returns
true iff reading the envelope was successful

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ getInputCount()

virtual int yarp::os::Contactable::getInputCount ( )
pure virtual

Determine how many connections are arriving into this port.

In other words, how many other ports have this port listed as an output?

Returns
number of input connections

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ getName()

std::string yarp::os::Contactable::getName ( ) const
virtual

Get name of port.

Returns
name of port

Reimplemented in yarp::os::BufferedPort< T >, and yarp::os::AbstractContactable.

Examples
os/portable_pair.cpp.

Definition at line 17 of file Contactable.cpp.

◆ getOutputCount()

virtual int yarp::os::Contactable::getOutputCount ( )
pure virtual

Determine how many output connections this port has.

Returns
number of output connections

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ getReport()

virtual void yarp::os::Contactable::getReport ( PortReport reporter)
pure virtual

Get information on the state of the port - connections etc.

PortReport::report will be called once for each connection to the port that exists right now. To request callbacks for any future connections/disconnections, use the setReporter method instead.

Parameters
reportercallback for port event/state information

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ getType()

virtual Type yarp::os::Contactable::getType ( )
pure virtual

Get the type of data the port has committed to send/receive.

Not all ports commit to a particular type of data.

Returns
type of data to expect/provide

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ includeNodeInName()

virtual void yarp::os::Contactable::includeNodeInName ( bool  flag)
pure virtual

Choose whether to prepend a node name (if one is available) to the port's name.

Node names are set using yarp::os::Node.

Parameters
flagtrue if the node name should be added to port names

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ interrupt()

virtual void yarp::os::Contactable::interrupt ( )
pure virtual

Interrupt any current reads or writes attached to the port.

This is useful prior to calling close(), if there are multiple threads operating on the port. Any reads or writes after the call to interrupt() will fail - unless resume() is called.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, yarp::os::Publisher< T >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::Publisher< ROS_MSG >, yarp::os::Publisher< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::Publisher< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Image >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::Subscriber< T >, yarp::os::Subscriber< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::MapMetaData >, and yarp::os::AbstractContactable.

◆ isWriting()

virtual bool yarp::os::Contactable::isWriting ( )
pure virtual

Report whether the port is currently writing data.

Returns
true iff the port is writing in the background.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ lockCallback()

virtual bool yarp::os::Contactable::lockCallback ( )
pure virtual

Lock callbacks until unlockCallback() is called.

Has no effect if no lock has been set via a call to setCallbackLock(). Will block if callbacks are already locked.

Returns
true if callbacks were locked

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ open() [1/2]

virtual bool yarp::os::Contactable::open ( const Contact contact,
bool  registerName = true 
)
pure virtual

Start port operation with user-chosen network parameters.

Contact information is supplied by the user rather than the name server. If the Contact information is incomplete, the name server is used to complete it (set registerName to false if you don't want name server help).

Returns
true iff the port started operation successfully and is now visible on the YARP network

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Publisher< T >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::Publisher< ROS_MSG >, yarp::os::Publisher< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::Publisher< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Image >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::Subscriber< T >, yarp::os::Subscriber< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ open() [2/2]

virtual bool yarp::os::Contactable::open ( const std::string &  name)
pure virtual

Start port operation, with a specific name, with automatically-chosen network parameters.

The port is registered with the given name, and allocated network resources, by communicating with the YARP name server.

Returns
true iff the port started operation successfully and is now visible on the YARP network

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Publisher< T >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::Publisher< ROS_MSG >, yarp::os::Publisher< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::Publisher< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Image >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::Subscriber< T >, yarp::os::Subscriber< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ promiseType()

virtual void yarp::os::Contactable::promiseType ( const Type typ)
pure virtual

Commit the port to a particular type of data.

Parameters
typthe type of data the port will send/receive

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ releaseProperties()

virtual void yarp::os::Contactable::releaseProperties ( Property prop)
pure virtual

End access unstructured port properties.

Parameters
propthe port property object provided by acquireProperties()

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ removeCallbackLock()

virtual bool yarp::os::Contactable::removeCallbackLock ( )
pure virtual

Remove a lock on callbacks added with setCallbackLock()

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ resetReporter()

virtual void yarp::os::Contactable::resetReporter ( )
pure virtual

Remove the callback which is called upon any future connections and disconnections to/from the port.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ resume()

virtual void yarp::os::Contactable::resume ( )
pure virtual

Put the port back in an operative state after interrupt() has been called.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, yarp::os::Publisher< T >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::Publisher< ROS_MSG >, yarp::os::Publisher< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::Publisher< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Image >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::Subscriber< T >, yarp::os::Subscriber< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::MapMetaData >, and yarp::os::AbstractContactable.

◆ setAdminReader()

virtual void yarp::os::Contactable::setAdminReader ( PortReader reader)
pure virtual

Set an external reader for unrecognized administrative port messages.

Parameters
readerthe external reader to use

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ setCallbackLock() [1/2]

virtual bool yarp::os::Contactable::setCallbackLock ( std::mutex *  mutex = nullptr)
pure virtual

Add a lock to use when invoking callbacks.

mutex.lock() will be called before and mutex.unlock() will be called after the callback. This applies at least to callbacks set by setReader and setAdminReader, and in future may apply to other callbacks.

Parameters
mutexthe lock to use. If nullptr, a mutex will be allocated internally by the port, and destroyed with the port.

Implemented in yarp::os::Port, yarp::os::AbstractContactable, yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, and yarp::os::BufferedPort< yarp::sig::Sound >.

◆ setCallbackLock() [2/2]

virtual bool yarp::os::Contactable::setCallbackLock ( yarp::os::Mutex mutex)
pure virtual

Add a lock to use when invoking callbacks.

mutex.lock() will be called before and mutex.unlock() will be called after the callback. This applies at least to callbacks set by setReader and setAdminReader, and in future may apply to other callbacks.

Parameters
mutexthe lock to use. If nullptr, a mutex will be allocated internally by the port, and destroyed with the port.
Deprecated:
since YARP 3.3

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ setEnvelope()

virtual bool yarp::os::Contactable::setEnvelope ( PortWriter envelope)
pure virtual

Set an envelope (e.g., a timestamp) to the next message which will be sent.

You must be sure to match the type of your envelope for setEnvelope with whatever will be read using getEnvelope. The Stamp class is a typical choice for timestamps. The Bottle class also works as an envelope, but it is not specialized to be efficient.

Currently, for proper operation, the envelope must serialize correctly in text-mode (even if you do not explicitly use text-mode connections). Bottle or Stamp are good choices.

Parameters
envelopeinformation to add to the next message which will be sent
Returns
true iff setting the envelope was successful

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ setInputMode()

virtual void yarp::os::Contactable::setInputMode ( bool  expectInput)
pure virtual

Configure the port to allow or forbid inputs.

By default, ports allow anything.

Parameters
expectInputset to true if this port will be used for input

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, yarp::os::AbstractContactable, yarp::os::RpcServer, and yarp::os::RpcClient.

◆ setOutputMode()

virtual void yarp::os::Contactable::setOutputMode ( bool  expectOutput)
pure virtual

Configure the port to allow or forbid outputs.

By default, ports allow anything.

Parameters
expectOutputset to true if this port will be used for output

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, yarp::os::AbstractContactable, yarp::os::RpcServer, and yarp::os::RpcClient.

◆ setReader()

virtual void yarp::os::Contactable::setReader ( PortReader reader)
pure virtual

Set an external reader for port data.

Parameters
readerthe external reader to use

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, yarp::os::Publisher< T >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::Publisher< ROS_MSG >, yarp::os::Publisher< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::Publisher< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Publisher< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::Publisher< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Image >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::Publisher< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::Subscriber< T >, yarp::os::Subscriber< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::Subscriber< yarp::rosmsg::nav_msgs::MapMetaData >, and yarp::os::AbstractContactable.

◆ setReadOnly()

void yarp::os::Contactable::setReadOnly ( )

Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(false)

Definition at line 22 of file Contactable.cpp.

◆ setReporter()

virtual void yarp::os::Contactable::setReporter ( PortReport reporter)
pure virtual

Set a callback to be called upon any future connections and disconnections to/from the port.

To get information on the current connections that exist, use the getReport method instead.

Parameters
reportercallback for port event/state information

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ setRpcClient()

void yarp::os::Contactable::setRpcClient ( )

Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(true)

Definition at line 43 of file Contactable.cpp.

◆ setRpcMode()

virtual void yarp::os::Contactable::setRpcMode ( bool  expectRpc)
pure virtual

Configure the port to be RPC only.

By default all ports can be used for RPC or streaming communication.

Parameters
expectRpcset to true if this port will be used for RPC only

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, yarp::os::AbstractContactable, yarp::os::RpcServer, and yarp::os::RpcClient.

◆ setRpcServer()

void yarp::os::Contactable::setRpcServer ( )

Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(true)

Definition at line 36 of file Contactable.cpp.

◆ setWriteOnly()

void yarp::os::Contactable::setWriteOnly ( )

Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(false)

Definition at line 29 of file Contactable.cpp.

◆ tryLockCallback()

virtual bool yarp::os::Contactable::tryLockCallback ( )
pure virtual

Try to lock callbacks until unlockCallback() is called.

Has no effect if no lock has been set via a call to setCallbackLock(). Returns immediately.

Returns
true if callbacks were locked by this call, false if they were already locked.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ unlockCallback()

virtual void yarp::os::Contactable::unlockCallback ( )
pure virtual

Unlock callbacks.

Implemented in yarp::os::BufferedPort< T >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Temperature >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::WrenchStamped >, yarp::os::BufferedPort< yarp::sig::Vector >, yarp::os::BufferedPort< ImageType >, yarp::os::BufferedPort< yarp::sig::ImageOf< yarp::sig::PixelFloat > >, yarp::os::BufferedPort< yarp::sig::VectorOf >, yarp::os::BufferedPort< yarp::dev::impl::jointData >, yarp::os::BufferedPort< SensorStreamingData >, yarp::os::BufferedPort< yarp::os::Bottle >, yarp::os::BufferedPort< ROS_MSG >, yarp::os::BufferedPort< yarp::os::PortablePair >, yarp::os::BufferedPort< JoyData >, yarp::os::BufferedPort< yarp::rosmsg::visualization_msgs::MarkerArray >, yarp::os::BufferedPort< yarp::rosmsg::tf2_msgs::TFMessage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::CameraInfo >, yarp::os::BufferedPort< yarp::dev::Nav2D::Map2DLocation >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::OccupancyGrid >, yarp::os::BufferedPort< yarp::rosmsg::geometry_msgs::PoseStamped >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::Odometry >, yarp::os::BufferedPort< yarp::rosmsg::nav_msgs::MapMetaData >, yarp::os::BufferedPort< yarp::sig::FlexImage >, yarp::os::BufferedPort< yarp::dev::LaserScan2D >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::JointState >, yarp::os::BufferedPort< yarp::dev::OdometryData >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::LaserScan >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Image >, yarp::os::BufferedPort< DepthImage >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::MagneticField >, yarp::os::BufferedPort< yarp::rosmsg::sensor_msgs::Imu >, yarp::os::BufferedPort< yarp::sig::Sound >, yarp::os::Port, and yarp::os::AbstractContactable.

◆ where()

virtual Contact yarp::os::Contactable::where ( ) const
pure virtual

Returns information about how this port can be reached.

Returns
network parameters for this port

Implemented in yarp::os::BufferedPort< T >, yarp::os::Port, and yarp::os::AbstractContactable.


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