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

A placeholder for rich contact information. More...

#include <yarp/os/NestedContact.h>

Detailed Description

A placeholder for rich contact information.

Includes types, and can express a ROS-style node/topic or node/service combination.

Definition at line 26 of file NestedContact.h.

Classes

class  Private
 

Public Member Functions

 NestedContact ()
 Default constructor. More...
 
 NestedContact (const std::string &fullName)
 Constructor. More...
 
 NestedContact (const NestedContact &rhs)
 Copy constructor. More...
 
 NestedContact (NestedContact &&rhs) noexcept
 Move constructor. More...
 
 ~NestedContact ()
 Destructor. More...
 
NestedContactoperator= (const NestedContact &rhs)
 Copy assignment operator. More...
 
NestedContactoperator= (NestedContact &&rhs) noexcept
 Move assignment operator. More...
 
bool fromString (const std::string &nFullName)
 
void setTypeName (const std::string &nWireType)
 
void setCategoryWrite ()
 
void setCategoryRead ()
 
std::string getFullName () const
 
std::string getNodeName () const
 
std::string getNestedName () const
 
std::string getCategory () const
 
std::string getTypeName () const
 
std::string getTypeNameStar () const
 
bool isNested () const
 
std::string toString () const
 

Constructor & Destructor Documentation

◆ NestedContact() [1/4]

NestedContact::NestedContact ( )

Default constructor.

Definition at line 99 of file NestedContact.cpp.

◆ NestedContact() [2/4]

NestedContact::NestedContact ( const std::string &  fullName)

Constructor.

Parameters
fullNamethe full name.

Definition at line 104 of file NestedContact.cpp.

◆ NestedContact() [3/4]

NestedContact::NestedContact ( const NestedContact rhs)

Copy constructor.

Parameters
rhsthe NestedContact to copy

Definition at line 110 of file NestedContact.cpp.

◆ NestedContact() [4/4]

NestedContact::NestedContact ( NestedContact &&  rhs)
noexcept

Move constructor.

Parameters
rhsthe NestedContact to be moved

Definition at line 115 of file NestedContact.cpp.

◆ ~NestedContact()

NestedContact::~NestedContact ( )

Destructor.

Definition at line 121 of file NestedContact.cpp.

Member Function Documentation

◆ fromString()

bool NestedContact::fromString ( const std::string &  nFullName)

Definition at line 142 of file NestedContact.cpp.

◆ getCategory()

std::string NestedContact::getCategory ( ) const

Definition at line 177 of file NestedContact.cpp.

◆ getFullName()

std::string NestedContact::getFullName ( ) const

Definition at line 162 of file NestedContact.cpp.

◆ getNestedName()

std::string NestedContact::getNestedName ( ) const

Definition at line 172 of file NestedContact.cpp.

◆ getNodeName()

std::string NestedContact::getNodeName ( ) const

Definition at line 167 of file NestedContact.cpp.

◆ getTypeName()

std::string NestedContact::getTypeName ( ) const

Definition at line 182 of file NestedContact.cpp.

◆ getTypeNameStar()

std::string NestedContact::getTypeNameStar ( ) const

Definition at line 187 of file NestedContact.cpp.

◆ isNested()

bool NestedContact::isNested ( ) const

Definition at line 192 of file NestedContact.cpp.

◆ operator=() [1/2]

NestedContact & NestedContact::operator= ( const NestedContact rhs)

Copy assignment operator.

Parameters
rhsthe NestedContact to copy
Returns
this object

Definition at line 126 of file NestedContact.cpp.

◆ operator=() [2/2]

NestedContact & NestedContact::operator= ( NestedContact &&  rhs)
noexcept

Move assignment operator.

Parameters
rhsthe NestedContact to be moved
Returns
this object

Definition at line 134 of file NestedContact.cpp.

◆ setCategoryRead()

void NestedContact::setCategoryRead ( )

Definition at line 157 of file NestedContact.cpp.

◆ setCategoryWrite()

void NestedContact::setCategoryWrite ( )

Definition at line 152 of file NestedContact.cpp.

◆ setTypeName()

void NestedContact::setTypeName ( const std::string &  nWireType)

Definition at line 147 of file NestedContact.cpp.

◆ toString()

std::string NestedContact::toString ( ) const

Definition at line 197 of file NestedContact.cpp.


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