YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
SerialPort_nws_yarp Class Reference

serialPort_nws_yarp: Export a serial sensor. More...

#include <serialPort_nws_yarp/serialPort_nws_yarp.h>

+ Inheritance diagram for SerialPort_nws_yarp:

Public Member Functions

 SerialPort_nws_yarp ()=default
 
 SerialPort_nws_yarp (const SerialPort_nws_yarp &)=delete
 
 SerialPort_nws_yarp (SerialPort_nws_yarp &&)=delete
 
SerialPort_nws_yarpoperator= (const SerialPort_nws_yarp &)=delete
 
SerialPort_nws_yarpoperator= (SerialPort_nws_yarp &&)=delete
 
virtual ~SerialPort_nws_yarp () override
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
void run () override
 Main body of the new thread.
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriveroperator= (const DeviceDriver &other)=delete
 
DeviceDriveroperator= (DeviceDriver &&other) noexcept=delete
 
 ~DeviceDriver () override
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from yarp::os::IConfig
virtual ~IConfig ()
 Destructor.
 
virtual bool configure (Searchable &config)
 Change online parameters.
 
- Public Member Functions inherited from yarp::os::Thread
 Thread ()
 Constructor.
 
virtual ~Thread ()
 Destructor.
 
virtual void onStop ()
 Call-back, called while halting the thread (before join).
 
bool start ()
 Start the new thread running.
 
bool stop ()
 Stop the thread.
 
virtual void beforeStart ()
 Called just before a new thread starts.
 
virtual void afterStart (bool success)
 Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start().
 
virtual bool threadInit ()
 Initialization method.
 
virtual void threadRelease ()
 Release method.
 
bool isStopping ()
 Returns true if the thread is stopping (Thread::stop has been called).
 
bool isRunning ()
 Returns true if the thread is running (Thread::start has been called successfully and the thread has not stopped).
 
long int getKey ()
 Get a unique identifier for the thread.
 
int setPriority (int priority, int policy=-1)
 Set the priority and scheduling policy of the thread, if the OS supports that.
 
int getPriority ()
 Query the current priority of the thread, if the OS supports that.
 
int getPolicy ()
 Query the current scheduling policy of the thread, if the OS supports that.
 
bool join (double seconds=-1)
 The function returns when the thread execution has completed.
 
void setOptions (int stackSize=0)
 Set the stack size for the new thread.
 
- Public Member Functions inherited from yarp::dev::WrapperSingle
 ~WrapperSingle () override
 Destructor.
 
bool attachAll (const yarp::dev::PolyDriverList &drivers) final
 Attach to a list of objects.
 
bool detachAll () final
 Detach the object (you must have first called attach).
 
- Public Member Functions inherited from yarp::dev::IWrapper
virtual ~IWrapper ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual ~IMultipleWrapper ()
 Destructor.
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Thread
static int getCount ()
 Check how many threads are running.
 
static long int getKeyOfCaller ()
 Get a unique identifier for the calling thread.
 
static void yield ()
 Reschedule the execution of current thread, allowing other threads to run.
 
static void setDefaultStackSize (int stackSize)
 Set the default stack size for all threads created after this point.
 

Detailed Description

serialPort_nws_yarp: Export a serial sensor.

The network interface is composed by two ports. The input port accepts bottles and sends their contents as text to the serial port. The output port streams out whatever information it gets in the serial port as text bottles.

Definition at line 74 of file serialPort_nws_yarp.h.

Constructor & Destructor Documentation

◆ SerialPort_nws_yarp() [1/3]

SerialPort_nws_yarp::SerialPort_nws_yarp ( )
default

◆ SerialPort_nws_yarp() [2/3]

SerialPort_nws_yarp::SerialPort_nws_yarp ( const SerialPort_nws_yarp )
delete

◆ SerialPort_nws_yarp() [3/3]

SerialPort_nws_yarp::SerialPort_nws_yarp ( SerialPort_nws_yarp &&  )
delete

◆ ~SerialPort_nws_yarp()

SerialPort_nws_yarp::~SerialPort_nws_yarp ( )
overridevirtual

Definition at line 15 of file serialPort_nws_yarp.cpp.

Member Function Documentation

◆ close()

bool SerialPort_nws_yarp::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 20 of file serialPort_nws_yarp.cpp.

◆ open()

bool SerialPort_nws_yarp::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 25 of file serialPort_nws_yarp.cpp.

◆ operator=() [1/2]

SerialPort_nws_yarp & SerialPort_nws_yarp::operator= ( const SerialPort_nws_yarp )
delete

◆ operator=() [2/2]

SerialPort_nws_yarp & SerialPort_nws_yarp::operator= ( SerialPort_nws_yarp &&  )
delete

◆ read()

bool SerialPort_nws_yarp::read ( yarp::os::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 136 of file serialPort_nws_yarp.cpp.

◆ run()

void SerialPort_nws_yarp::run ( )
overridevirtual

Main body of the new thread.

Override this method to do what you want. After Thread::start is called, this method will start running in a separate thread. It is important that this method either keeps checking Thread::isStopping to see if it should stop, or you override the Thread::onStop method to interact with it in some way to shut the new thread down. There is no really reliable, portable way to stop a thread cleanly unless that thread cooperates.

Implements yarp::os::Thread.

Definition at line 48 of file serialPort_nws_yarp.cpp.


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