YARP
Yet Another Robot Platform
yarp::os::YarpDummyNameSpace Class Reference

#include <yarp/os/YarpNameSpace.h>

+ Inheritance diagram for yarp::os::YarpDummyNameSpace:

Detailed Description

Definition at line 172 of file YarpNameSpace.h.

Public Member Functions

 YarpDummyNameSpace ()
 
bool localOnly () const override
 Check if the NameSpace is only valid for the current process ("local"). More...
 
Contact getNameServerContact () const override
 Get an address for a name server that manages the name space, if available. More...
 
- Public Member Functions inherited from yarp::os::YarpNameSpace
 YarpNameSpace (const Contact &contact)
 
virtual ~YarpNameSpace ()
 
Contact queryName (const std::string &name) override
 Map from port name to contact information. More...
 
Contact registerName (const std::string &name) override
 Record contact information to tie to a port name. More...
 
Contact registerContact (const Contact &contact) override
 Record contact information (should include a port name). More...
 
Contact unregisterName (const std::string &name) override
 Disassociate contact information from a port name. More...
 
Contact unregisterContact (const Contact &contact) override
 Disassociate contact information (should include a port name). More...
 
virtual bool setProperty (const std::string &name, const std::string &key, const Value &value) override
 Associate a key/value pair with a named port. More...
 
virtual ValuegetProperty (const std::string &name, const std::string &key) override
 Get the value of a named key from a named port. More...
 
virtual bool connectPortToTopic (const Contact &src, const Contact &dest, ContactStyle style) override
 Publish a port to a topic. More...
 
virtual bool connectTopicToPort (const Contact &src, const Contact &dest, ContactStyle style) override
 Subscribe a port to a topic. More...
 
virtual bool disconnectPortFromTopic (const Contact &src, const Contact &dest, ContactStyle style) override
 Stop publishing a port to a topic. More...
 
virtual bool disconnectTopicFromPort (const Contact &src, const Contact &dest, ContactStyle style) override
 Stop subscribing a port to a topic. More...
 
virtual bool connectPortToPortPersistently (const Contact &src, const Contact &dest, ContactStyle style) override
 Connect two ports with persistence. More...
 
virtual bool disconnectPortToPortPersistently (const Contact &src, const Contact &dest, ContactStyle style) override
 Disconnect two ports, removing any persistence. More...
 
virtual bool connectTopic (const std::string &dir, bool srcIsTopic, bool destIsTopic, const Contact &src, const Contact &dest, ContactStyle style)
 
bool usesCentralServer () const override
 Check if a central server is involved in managing the NameSpace. More...
 
bool serverAllocatesPortNumbers () const override
 Check if a central server is responsible for allocating port numbers, or if this should be left up to the operating system. More...
 
bool connectionHasNameOfEndpoints () const override
 When connections are made involving ports managed by this NameSpace do the ports involved end up knowing the names of their counterparties? More...
 
virtual Contact detectNameServer (bool useDetectedServer, bool &scanNeeded, bool &serverUsed) override
 Find a name server for this NameSpace, if applicable. More...
 
virtual bool writeToNameServer (PortWriter &cmd, PortReader &reply, const ContactStyle &style) override
 Write a message to a name server for this NameSpace, if applicable. More...
 
- Public Member Functions inherited from yarp::os::NameSpace
virtual ~NameSpace ()
 Destructor. More...
 
virtual bool checkNetwork ()
 Check if a name space is available. More...
 
virtual bool checkNetwork (double timeout)
 Check if a name space is available, with a timeout on any network operations needed. More...
 
virtual std::string getNameServerName () const
 Get the port name of a name server that manages the name space, if available. More...
 
virtual Contact registerAdvanced (const Contact &contact, NameStore *store)
 Record contact information, with access to the contact information of other ports for cross-referencing. More...
 
virtual Contact unregisterAdvanced (const std::string &name, NameStore *store)
 Remove contact information, with access to the contact information of other ports for cross-referencing. More...
 

Constructor & Destructor Documentation

◆ YarpDummyNameSpace()

yarp::os::YarpDummyNameSpace::YarpDummyNameSpace ( )
inline

Definition at line 175 of file YarpNameSpace.h.

Member Function Documentation

◆ getNameServerContact()

Contact yarp::os::YarpDummyNameSpace::getNameServerContact ( ) const
inlineoverridevirtual

Get an address for a name server that manages the name space, if available.

Reimplemented from yarp::os::YarpNameSpace.

Definition at line 182 of file YarpNameSpace.h.

◆ localOnly()

bool yarp::os::YarpDummyNameSpace::localOnly ( ) const
inlineoverridevirtual

Check if the NameSpace is only valid for the current process ("local").

Reimplemented from yarp::os::YarpNameSpace.

Definition at line 177 of file YarpNameSpace.h.


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