Yet Another Robot Platform
yarp::os::Node::Helper Class Reference
+ Inheritance diagram for yarp::os::Node::Helper:

Public Member Functions

 Helper ()
 ~Helper () override
void clear ()
void add (Contactable &contactable)
void update (Contactable &contactable)
void remove (Contactable &contactable)
std::vector< Contactquery (const std::string &name, const std::string &category=std::string())
void prepare (const std::string &name)
void interrupt ()
bool read (ConnectionReader &reader) override
 Read this object from a network connection. More...
void getBusStats (NodeArgs &na)
void getBusInfo (NodeArgs &na)
void getMasterUri (NodeArgs &na)
void shutdown (NodeArgs &na)
void getPid (NodeArgs &na)
void getSubscriptions (NodeArgs &na)
void getPublications (NodeArgs &na)
void paramUpdate (NodeArgs &na)
void publisherUpdate (NodeArgs &na)
void requestTopic (NodeArgs &na)
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
virtual Type getReadType () const

Public Attributes

std::multimap< std::string, NodeItemby_part_name
std::multimap< std::string, NodeItemby_category
std::map< Contactable *, NodeItemname_cache
Port port
Nodeowner {nullptr}
std::mutex mutex
std::string name
std::string prev_name
bool has_prev_name {false}

Detailed Description

Definition at line 179 of file Node.cpp.

Constructor & Destructor Documentation

◆ Helper()

yarp::os::Node::Helper::Helper ( )

Definition at line 193 of file Node.cpp.

◆ ~Helper()

yarp::os::Node::Helper::~Helper ( )

Definition at line 199 of file Node.cpp.

Member Function Documentation

◆ add()

void yarp::os::Node::Helper::add ( Contactable contactable)

Definition at line 429 of file Node.cpp.

◆ clear()

void yarp::os::Node::Helper::clear ( )

Definition at line 205 of file Node.cpp.

◆ getBusInfo()

void yarp::os::Node::Helper::getBusInfo ( NodeArgs na)

Definition at line 251 of file Node.cpp.

◆ getBusStats()

void yarp::os::Node::Helper::getBusStats ( NodeArgs na)

Definition at line 245 of file Node.cpp.

◆ getMasterUri()

void yarp::os::Node::Helper::getMasterUri ( NodeArgs na)

Definition at line 299 of file Node.cpp.

◆ getPid()

void yarp::os::Node::Helper::getPid ( NodeArgs na)

Definition at line 310 of file Node.cpp.

◆ getPublications()

void yarp::os::Node::Helper::getPublications ( NodeArgs na)

Definition at line 336 of file Node.cpp.

◆ getSubscriptions()

void yarp::os::Node::Helper::getSubscriptions ( NodeArgs na)

Definition at line 316 of file Node.cpp.

◆ interrupt()

void yarp::os::Node::Helper::interrupt ( )

Definition at line 238 of file Node.cpp.

◆ paramUpdate()

void yarp::os::Node::Helper::paramUpdate ( NodeArgs na)

Definition at line 356 of file Node.cpp.

◆ prepare()

void yarp::os::Node::Helper::prepare ( const std::string &  name)

Definition at line 413 of file Node.cpp.

◆ publisherUpdate()

void yarp::os::Node::Helper::publisherUpdate ( NodeArgs na)

Definition at line 361 of file Node.cpp.

◆ query()

std::vector< Contact > yarp::os::Node::Helper::query ( const std::string &  name,
const std::string &  category = std::string() 

Definition at line 479 of file Node.cpp.

◆ read()

bool yarp::os::Node::Helper::read ( ConnectionReader reader)

Read this object from a network connection.

Override this for your particular class.

readeran interface to the network connection for reading
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 493 of file Node.cpp.

◆ remove()

void yarp::os::Node::Helper::remove ( Contactable contactable)

Definition at line 457 of file Node.cpp.

◆ requestTopic()

void yarp::os::Node::Helper::requestTopic ( NodeArgs na)

Definition at line 387 of file Node.cpp.

◆ shutdown()

void yarp::os::Node::Helper::shutdown ( NodeArgs na)

Definition at line 305 of file Node.cpp.

◆ update()

void yarp::os::Node::Helper::update ( Contactable contactable)

Definition at line 450 of file Node.cpp.

Member Data Documentation

◆ by_category

std::multimap<std::string, NodeItem> yarp::os::Node::Helper::by_category

Definition at line 183 of file Node.cpp.

◆ by_part_name

std::multimap<std::string, NodeItem> yarp::os::Node::Helper::by_part_name

Definition at line 182 of file Node.cpp.

◆ has_prev_name

bool yarp::os::Node::Helper::has_prev_name {false}

Definition at line 191 of file Node.cpp.

◆ mutex

std::mutex yarp::os::Node::Helper::mutex

Definition at line 188 of file Node.cpp.

◆ name

std::string yarp::os::Node::Helper::name

Definition at line 189 of file Node.cpp.

◆ name_cache

std::map<Contactable*, NodeItem> yarp::os::Node::Helper::name_cache

Definition at line 184 of file Node.cpp.

◆ owner

Node* yarp::os::Node::Helper::owner {nullptr}

Definition at line 186 of file Node.cpp.

◆ port

Port yarp::os::Node::Helper::port

Definition at line 185 of file Node.cpp.

◆ prev_name

std::string yarp::os::Node::Helper::prev_name

Definition at line 190 of file Node.cpp.

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