YARP
Yet Another Robot Platform
Public Member Functions | Public Attributes | List of all members
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< Contact > query (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 Type getReadType () const
 

Public Attributes

std::multimap< std::string, NodeItem > by_part_name
 
std::multimap< std::string, NodeItem > by_category
 
std::map< Contactable *, NodeItem > name_cache
 
Port port
 
Node * owner {nullptr}
 
std::mutex mutex
 
std::string name
 
std::string prev_name
 
bool has_prev_name {false}
 

Detailed Description

Definition at line 182 of file Node.cpp.

Constructor & Destructor Documentation

◆ Helper()

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

Definition at line 196 of file Node.cpp.

◆ ~Helper()

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

Definition at line 202 of file Node.cpp.

Member Function Documentation

◆ add()

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

Definition at line 432 of file Node.cpp.

◆ clear()

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

Definition at line 208 of file Node.cpp.

◆ getBusInfo()

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

Definition at line 254 of file Node.cpp.

◆ getBusStats()

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

Definition at line 248 of file Node.cpp.

◆ getMasterUri()

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

Definition at line 302 of file Node.cpp.

◆ getPid()

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

Definition at line 313 of file Node.cpp.

◆ getPublications()

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

Definition at line 339 of file Node.cpp.

◆ getSubscriptions()

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

Definition at line 319 of file Node.cpp.

◆ interrupt()

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

Definition at line 241 of file Node.cpp.

◆ paramUpdate()

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

Definition at line 359 of file Node.cpp.

◆ prepare()

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

Definition at line 416 of file Node.cpp.

◆ publisherUpdate()

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

Definition at line 364 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 482 of file Node.cpp.

◆ read()

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

Read this object from a network connection.

Override this for your particular class.

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

Implements yarp::os::PortReader.

Definition at line 496 of file Node.cpp.

◆ remove()

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

Definition at line 460 of file Node.cpp.

◆ requestTopic()

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

Definition at line 390 of file Node.cpp.

◆ shutdown()

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

Definition at line 308 of file Node.cpp.

◆ update()

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

Definition at line 453 of file Node.cpp.

Member Data Documentation

◆ by_category

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

Definition at line 186 of file Node.cpp.

◆ by_part_name

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

Definition at line 185 of file Node.cpp.

◆ has_prev_name

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

Definition at line 194 of file Node.cpp.

◆ mutex

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

Definition at line 191 of file Node.cpp.

◆ name

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

Definition at line 192 of file Node.cpp.

◆ name_cache

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

Definition at line 187 of file Node.cpp.

◆ owner

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

Definition at line 189 of file Node.cpp.

◆ port

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

Definition at line 188 of file Node.cpp.

◆ prev_name

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

Definition at line 193 of file Node.cpp.

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