LLM_nws_yarp Class Reference

LLM_nws_yarp: A server which can be wrap multiple algorithms and devices to provide LLM services. More...

#include <LLM_nws_yarp/LLM_nws_yarp.h>

Inheritance diagram for LLM_nws_yarp:

Public Member Functions
virtual bool	open (yarp::os::Searchable &prop) override
	Open the DeviceDriver.
virtual bool	close () override
	Close the DeviceDriver.
virtual bool	attach (yarp::dev::PolyDriver *drv) override
	Attach to another object.
virtual bool	detach () override
	Detach the object (you must have first called attach).
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()
	DeviceDriver (const DeviceDriver &other)=delete
	DeviceDriver (DeviceDriver &&other) noexcept=delete
DeviceDriver &	operator= (const DeviceDriver &other)=delete
DeviceDriver &	operator= (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 DeviceDriver *	getImplementation ()
	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::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

Protected Attributes
ILLMRPCd	m_RPC
yarp::os::RpcServer	m_RpcPort
yarp::dev::ILLM *	m_iLlm = nullptr

Detailed Description

LLM_nws_yarp: A server which can be wrap multiple algorithms and devices to provide LLM services.

LLM_nws_yarp

Parameters required by this device are:

Parameter name	SubParameter	Type	Units	Default Value	Required	Description	Notes
name	-	string	-	-	Yes	Full name of the rpc port opened by device, e.g. /LLM_nws/rpc

Definition at line 27 of file LLM_nws_yarp.h.

Member Function Documentation

attach()

bool LLM_nws_yarp::attach ( yarp::dev::PolyDriver *  driver )

overridevirtual

Attach to another object.

Parameters

driver

the polydriver that you want to attach to.

Returns

true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 16 of file LLM_nws_yarp.cpp.

close()

bool LLM_nws_yarp::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 86 of file LLM_nws_yarp.cpp.

detach()

bool LLM_nws_yarp::detach ( )

overridevirtual

Detach the object (you must have first called attach).

Returns

true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 80 of file LLM_nws_yarp.cpp.

open()

bool LLM_nws_yarp::open ( yarp::os::Searchable &  config )

overridevirtual

Open the DeviceDriver.

Parameters

config

is 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 36 of file LLM_nws_yarp.cpp.

read()

bool LLM_nws_yarp::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 94 of file LLM_nws_yarp.cpp.

Member Data Documentation

m_iLlm

yarp::dev::ILLM* LLM_nws_yarp::m_iLlm = nullptr

protected

Definition at line 38 of file LLM_nws_yarp.h.

m_RPC

ILLMRPCd LLM_nws_yarp::m_RPC

protected

Definition at line 36 of file LLM_nws_yarp.h.

m_RpcPort

yarp::os::RpcServer LLM_nws_yarp::m_RpcPort

protected

Definition at line 37 of file LLM_nws_yarp.h.

---

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

• src/devices/LLM_nws_yarp/LLM_nws_yarp.h
• src/devices/LLM_nws_yarp/LLM_nws_yarp.cpp