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

Public Member Functions

 Helper ()
 
 ~Helper ()
 
void clear ()
 
void add (Contactable &contactable)
 
void update (Contactable &contactable)
 
void remove (Contactable &contactable)
 
std::vector< Contactquery (const ConstString &name, const ConstString &category=ConstString())
 
void prepare (const ConstString &name)
 
void interrupt ()
 
virtual 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 ()
 

Public Attributes

std::multimap< ConstString, NodeItemby_part_name
 
std::multimap< ConstString, NodeItemby_category
 
std::map< Contactable *, NodeItemname_cache
 
Port port
 
Nodeowner
 
Mutex mutex
 
ConstString name
 
ConstString prev_name
 
bool has_prev_name
 

Detailed Description

Definition at line 170 of file Node.cpp.

Constructor & Destructor Documentation

◆ Helper()

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

Definition at line 184 of file Node.cpp.

◆ ~Helper()

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

Definition at line 193 of file Node.cpp.

Member Function Documentation

◆ add()

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

Definition at line 426 of file Node.cpp.

◆ clear()

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

Definition at line 199 of file Node.cpp.

◆ getBusInfo()

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

Definition at line 245 of file Node.cpp.

◆ getBusStats()

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

Definition at line 239 of file Node.cpp.

◆ getMasterUri()

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

Definition at line 293 of file Node.cpp.

◆ getPid()

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

Definition at line 304 of file Node.cpp.

◆ getPublications()

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

Definition at line 330 of file Node.cpp.

◆ getSubscriptions()

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

Definition at line 310 of file Node.cpp.

◆ interrupt()

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

Definition at line 232 of file Node.cpp.

◆ paramUpdate()

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

Definition at line 350 of file Node.cpp.

◆ prepare()

void yarp::os::Node::Helper::prepare ( const ConstString name)

Definition at line 410 of file Node.cpp.

◆ publisherUpdate()

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

Definition at line 355 of file Node.cpp.

◆ query()

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

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

◆ remove()

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

Definition at line 453 of file Node.cpp.

◆ requestTopic()

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

Definition at line 382 of file Node.cpp.

◆ shutdown()

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

Definition at line 299 of file Node.cpp.

◆ update()

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

Definition at line 446 of file Node.cpp.

Member Data Documentation

◆ by_category

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

Definition at line 174 of file Node.cpp.

◆ by_part_name

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

Definition at line 173 of file Node.cpp.

◆ has_prev_name

bool yarp::os::Node::Helper::has_prev_name

Definition at line 182 of file Node.cpp.

◆ mutex

Mutex yarp::os::Node::Helper::mutex

Definition at line 179 of file Node.cpp.

◆ name

ConstString yarp::os::Node::Helper::name

Definition at line 180 of file Node.cpp.

◆ name_cache

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

Definition at line 175 of file Node.cpp.

◆ owner

Node* yarp::os::Node::Helper::owner

Definition at line 177 of file Node.cpp.

◆ port

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

Definition at line 176 of file Node.cpp.

◆ prev_name

ConstString yarp::os::Node::Helper::prev_name

Definition at line 181 of file Node.cpp.


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