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

Simple abstraction for a YARP port name. More...

#include <yarp/os/Name.h>

Detailed Description

Simple abstraction for a YARP port name.

Definition at line 24 of file Name.h.

Public Member Functions

 Name (const std::string &txt)
 Constructor. More...
 
bool isRooted () const
 Check if port name begins with "/". More...
 
Contact toAddress () const
 Create an address from the name. More...
 
std::string getCarrierModifier (const char *mod, bool *hasModifier=nullptr)
 

Private Member Functions

 YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG (std::string) txt
 

Constructor & Destructor Documentation

◆ Name()

Name::Name ( const std::string &  txt)

Constructor.

Parameters
txtthe port name.

Definition at line 14 of file Name.cpp.

Member Function Documentation

◆ getCarrierModifier()

std::string Name::getCarrierModifier ( const char *  mod,
bool *  hasModifier = nullptr 
)

Definition at line 44 of file Name.cpp.

◆ isRooted()

bool Name::isRooted ( ) const

Check if port name begins with "/".

Returns
true if port name begins with "/"

Definition at line 18 of file Name.cpp.

◆ toAddress()

Contact Name::toAddress ( ) const

Create an address from the name.

Fills in carrier and name fields. Deals with "tcp://port/name" style syntax.

Returns
a partially filled address (there is no communication with the name server, just parsing of information in the name).

Definition at line 28 of file Name.cpp.

◆ YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG()

yarp::os::Name::YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG ( std::string  )
private

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