RMW desert 1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
DesertNode Class Reference

Public Member Functions

 DesertNode (std::string name, std::string namespace_, rmw_gid_t gid)
 Create a node.
 
void add_publisher (DesertPublisher *pub)
 Add a publisher to the current node.
 
void add_subscriber (DesertSubscriber *sub)
 Add a subscriber to the current node.
 
void add_client (DesertClient *cli)
 Add a client to the current node.
 
void add_service (DesertService *ser)
 Add a service to the current node.
 
void remove_publisher (DesertPublisher *pub)
 Remove a publisher from the current node.
 
void remove_subscriber (DesertSubscriber *sub)
 Remove a subscriber from the current node.
 
void remove_client (DesertClient *cli)
 Remove a client from the current node.
 
void remove_service (DesertService *ser)
 Remove a service from the current node.
 
rmw_gid_t get_gid ()
 Retreive the gid of the current entity.
 

Constructor & Destructor Documentation

◆ DesertNode()

DesertNode::DesertNode ( std::string  name,
std::string  namespace_,
rmw_gid_t  gid 
)

Create a node.

Parameters
nameName of the node
namespace_Namespace of the node
gidGlobal identifier of the node

Member Function Documentation

◆ add_client()

void DesertNode::add_client ( DesertClient cli)

Add a client to the current node.

This function pushes the pointer to a client in a vector of all the registered clients related to the current node.

Parameters
cliPointer to a DesertClient instance

◆ add_publisher()

void DesertNode::add_publisher ( DesertPublisher pub)

Add a publisher to the current node.

This function pushes the pointer to a publisher in a vector of all the registered publishers related to the current node.

Parameters
pubPointer to a DesertPublisher instance

◆ add_service()

void DesertNode::add_service ( DesertService ser)

Add a service to the current node.

This function pushes the pointer to a service in a vector of all the registered services related to the current node.

Parameters
serPointer to a DesertService instance

◆ add_subscriber()

void DesertNode::add_subscriber ( DesertSubscriber sub)

Add a subscriber to the current node.

This function pushes the pointer to a subscriber in a vector of all the registered subscribers related to the current node.

Parameters
subPointer to a DesertSubscriber instance

◆ get_gid()

rmw_gid_t DesertNode::get_gid ( )

Retreive the gid of the current entity.

This function returns the global identifier of the current entity in the rmw format.

Returns
Global identifier of the entity

◆ remove_client()

void DesertNode::remove_client ( DesertClient cli)

Remove a client from the current node.

This function removes the pointer to a client from the vector of all the registered clients related to the current node.

Parameters
cliPointer to a DesertClient instance

◆ remove_publisher()

void DesertNode::remove_publisher ( DesertPublisher pub)

Remove a publisher from the current node.

This function removes the pointer to a publisher from the vector of all the registered publishers related to the current node.

Parameters
pubPointer to a DesertPublisher instance

◆ remove_service()

void DesertNode::remove_service ( DesertService ser)

Remove a service from the current node.

This function removes the pointer to a service from the vector of all the registered services related to the current node.

Parameters
serPointer to a DesertService instance

◆ remove_subscriber()

void DesertNode::remove_subscriber ( DesertSubscriber sub)

Remove a subscriber from the current node.

This function removes the pointer to a subscriber from the vector of all the registered subscribers related to the current node.

Parameters
subPointer to a DesertSubscriber instance

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