YARP  2.3.68+272-20170522.1+git50f0ae7
Yet Another Robot Platform
yarp::os::NestedContact Class Reference

A placeholder for rich contact information. More...

#include <yarp/os/NestedContact.h>

Public Member Functions

 NestedContact ()
 
 NestedContact (const ConstString &nFullName)
 
bool fromString (const ConstString &nFullName)
 
void setTypeName (const ConstString &nWireType)
 
void setCategoryWrite ()
 
void setCategoryRead ()
 
ConstString getFullName () const
 
ConstString getNodeName () const
 
ConstString getNestedName () const
 
ConstString getCategory () const
 
ConstString getTypeName () const
 
ConstString getTypeNameStar () const
 
bool isNested () const
 
ConstString toString () const
 

Private Attributes

ConstString fullName
 
ConstString nodeName
 
ConstString nestedName
 
ConstString category
 
ConstString wireType
 

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 24 of file NestedContact.h.

Constructor & Destructor Documentation

◆ NestedContact() [1/2]

yarp::os::NestedContact::NestedContact ( )
inline

Definition at line 26 of file NestedContact.h.

◆ NestedContact() [2/2]

NestedContact::NestedContact ( const ConstString nFullName)

Definition at line 12 of file NestedContact.cpp.

Member Function Documentation

◆ fromString()

bool NestedContact::fromString ( const ConstString nFullName)

Definition at line 16 of file NestedContact.cpp.

◆ getCategory()

ConstString yarp::os::NestedContact::getCategory ( ) const
inline

Definition at line 55 of file NestedContact.h.

◆ getFullName()

ConstString yarp::os::NestedContact::getFullName ( ) const
inline

Definition at line 44 of file NestedContact.h.

◆ getNestedName()

ConstString yarp::os::NestedContact::getNestedName ( ) const
inline

Definition at line 51 of file NestedContact.h.

◆ getNodeName()

ConstString yarp::os::NestedContact::getNodeName ( ) const
inline

Definition at line 47 of file NestedContact.h.

◆ getTypeName()

ConstString yarp::os::NestedContact::getTypeName ( ) const
inline

Definition at line 59 of file NestedContact.h.

◆ getTypeNameStar()

ConstString yarp::os::NestedContact::getTypeNameStar ( ) const
inline

Definition at line 63 of file NestedContact.h.

◆ isNested()

bool yarp::os::NestedContact::isNested ( ) const
inline

Definition at line 68 of file NestedContact.h.

◆ setCategoryRead()

void yarp::os::NestedContact::setCategoryRead ( )
inline

Definition at line 40 of file NestedContact.h.

◆ setCategoryWrite()

void yarp::os::NestedContact::setCategoryWrite ( )
inline

Definition at line 36 of file NestedContact.h.

◆ setTypeName()

void yarp::os::NestedContact::setTypeName ( const ConstString nWireType)
inline

Definition at line 32 of file NestedContact.h.

◆ toString()

ConstString yarp::os::NestedContact::toString ( ) const
inline

Definition at line 72 of file NestedContact.h.

Member Data Documentation

◆ category

ConstString yarp::os::NestedContact::category
private

Definition at line 80 of file NestedContact.h.

◆ fullName

ConstString yarp::os::NestedContact::fullName
private

Definition at line 77 of file NestedContact.h.

◆ nestedName

ConstString yarp::os::NestedContact::nestedName
private

Definition at line 79 of file NestedContact.h.

◆ nodeName

ConstString yarp::os::NestedContact::nodeName
private

Definition at line 78 of file NestedContact.h.

◆ wireType

ConstString yarp::os::NestedContact::wireType
private

Definition at line 81 of file NestedContact.h.


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