Yet Another Robot Platform
No Matches
SpeechTranscription_nws_yarp Class Reference

SpeechTranscription_nws_yarp: A wrapper for a plugin able to perform speech transcription. More...

#include <networkWrappers/speechTranscription_nws_yarp/SpeechTranscription_nws_yarp.h>

+ Inheritance diagram for SpeechTranscription_nws_yarp:

Public Member Functions

 SpeechTranscription_nws_yarp ()=default
 SpeechTranscription_nws_yarp (const SpeechTranscription_nws_yarp &)=delete
 SpeechTranscription_nws_yarp (SpeechTranscription_nws_yarp &&)=delete
SpeechTranscription_nws_yarpoperator= (const SpeechTranscription_nws_yarp &)=delete
SpeechTranscription_nws_yarpoperator= (SpeechTranscription_nws_yarp &&)=delete
virtual ~SpeechTranscription_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
virtual ~DeviceDriver ()
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::Thread
 Thread ()
virtual ~Thread ()
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
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 ()
- Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual ~IMultipleWrapper ()
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
virtual Type getReadType () const
- Public Member Functions inherited from SpeechTranscription_nws_yarp_ParamsParser
 SpeechTranscription_nws_yarp_ParamsParser ()
 ~SpeechTranscription_nws_yarp_ParamsParser () override=default
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
std::string getDeviceName () const override
 Get the name of the device (i.e.
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()

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.
- Public Attributes inherited from SpeechTranscription_nws_yarp_ParamsParser
const std::string m_device_classname = {"SpeechTranscription_nws_yarp"}
const std::string m_device_name = {"speechTranscription_nws_yarp"}
bool m_parser_is_strict = false
const parser_version_type m_parser_version = {}
const std::string m_name_defaultValue = {"/speechTranscription_nws"}
std::string m_name = {"/speechTranscription_nws"}

Detailed Description

SpeechTranscription_nws_yarp: A wrapper for a plugin able to perform speech transcription.

The network interface is composed by two ports. When a yarp::sig::Sound is received on the input port, the attached subdevice processes it and sends the transcription on the output port. The same functionality is available also via rpc port, which also provides additional functionalities, such as setting of the transcription language.

Parameters required by this device are shown in class: SpeechTranscription_nws_yarp_ParamsParser

Definition at line 82 of file SpeechTranscription_nws_yarp.h.

Constructor & Destructor Documentation

◆ SpeechTranscription_nws_yarp() [1/3]

SpeechTranscription_nws_yarp::SpeechTranscription_nws_yarp ( )

◆ SpeechTranscription_nws_yarp() [2/3]

SpeechTranscription_nws_yarp::SpeechTranscription_nws_yarp ( const SpeechTranscription_nws_yarp )

◆ SpeechTranscription_nws_yarp() [3/3]

SpeechTranscription_nws_yarp::SpeechTranscription_nws_yarp ( SpeechTranscription_nws_yarp &&  )

◆ ~SpeechTranscription_nws_yarp()

SpeechTranscription_nws_yarp::~SpeechTranscription_nws_yarp ( )

Definition at line 15 of file SpeechTranscription_nws_yarp.cpp.

Member Function Documentation

◆ close()

bool SpeechTranscription_nws_yarp::close ( )

Close the DeviceDriver.

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 20 of file SpeechTranscription_nws_yarp.cpp.

◆ open()

bool SpeechTranscription_nws_yarp::open ( yarp::os::Searchable config)

Open the DeviceDriver.

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).
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 25 of file SpeechTranscription_nws_yarp.cpp.

◆ operator=() [1/2]

SpeechTranscription_nws_yarp & SpeechTranscription_nws_yarp::operator= ( const SpeechTranscription_nws_yarp )

◆ operator=() [2/2]

SpeechTranscription_nws_yarp & SpeechTranscription_nws_yarp::operator= ( SpeechTranscription_nws_yarp &&  )

◆ read()

bool SpeechTranscription_nws_yarp::read ( yarp::os::ConnectionReader reader)

Read this object from a network connection.

Override this for your particular class.

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

Implements yarp::os::PortReader.

Definition at line 100 of file SpeechTranscription_nws_yarp.cpp.

◆ run()

void SpeechTranscription_nws_yarp::run ( )

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 43 of file SpeechTranscription_nws_yarp.cpp.

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