Drake
LcmReceiveThread Class Reference

Maintains a thread that receives LCM messages and dispatches the messages to the appropriate message handlers. More...

#include <drake/lcm/lcm_receive_thread.h>

Public Member Functions

 LcmReceiveThread (::lcm::LCM *lcm)
 A constructor that instantiates the thread. More...
 
 ~LcmReceiveThread ()
 The destructor that ensures the thread that receives LCM message is stopped. More...
 
void Stop ()
 Stops the LCM receive thread. More...
 
Does not allow copy, move, or assignment
 LcmReceiveThread (const LcmReceiveThread &)=delete
 
LcmReceiveThreadoperator= (const LcmReceiveThread &)=delete
 
 LcmReceiveThread (LcmReceiveThread &&)=delete
 
LcmReceiveThreadoperator= (LcmReceiveThread &&)=delete
 

Detailed Description

Maintains a thread that receives LCM messages and dispatches the messages to the appropriate message handlers.

Constructor & Destructor Documentation

◆ LcmReceiveThread() [1/3]

LcmReceiveThread ( const LcmReceiveThread )
delete

◆ LcmReceiveThread() [2/3]

◆ LcmReceiveThread() [3/3]

LcmReceiveThread ( ::lcm::LCM *  lcm)
explicit

A constructor that instantiates the thread.

Parameters
[in]lcmA pointer to the LCM instance through which to access the LCM network. This parameter cannot be nullptr and must remain valid for the lifetime of this object.

◆ ~LcmReceiveThread()

The destructor that ensures the thread that receives LCM message is stopped.

Member Function Documentation

◆ operator=() [1/2]

LcmReceiveThread& operator= ( const LcmReceiveThread )
delete

◆ operator=() [2/2]

LcmReceiveThread& operator= ( LcmReceiveThread &&  )
delete

◆ Stop()

void Stop ( )

Stops the LCM receive thread.

This stops the reception of LCM messages.


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