multipleanalogsensorsserver: The server side of the MultipleAnalogSensorsClient, useful to expose device implementing MultipleAnalogSensors interfaces over the YARP network. More...

#include <networkWrappers/multipleanalogsensorsserver/MultipleAnalogSensorsServer.h>

Inheritance diagram for MultipleAnalogSensorsServer:

Public Member Functions
	MultipleAnalogSensorsServer ()

	~MultipleAnalogSensorsServer ()

bool	open (yarp::os::Searchable &params) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

bool	attach (yarp::dev::PolyDriver *p) override
	Attach to another object.

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

void	threadRelease () override
	Release method.

void	run () override
	Loop function.

SensorRPCData	getMetadata () override
	Read the sensor metadata necessary to configure the MultipleAnalogSensorsClient device.

Public Member Functions inherited from yarp::os::PeriodicThread
	PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
	Constructor.

	PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
	Constructor.

virtual	~PeriodicThread ()

bool	start ()
	Call this to start the thread.

void	step ()
	Call this to "step" the thread rather than starting it.

void	stop ()
	Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called).

void	askToStop ()
	Stop the thread.

bool	isRunning () const
	Returns true when the thread is started, false otherwise.

bool	isSuspended () const
	Returns true when the thread is suspended, false otherwise.

bool	setPeriod (double period)
	Set the (new) period of the thread.

double	getPeriod () const
	Return the current period of the thread.

void	suspend ()
	Suspend the thread, the thread keeps running by doLoop is never executed.

void	resume ()
	Resume the thread if previously suspended.

void	resetStat ()
	Reset thread statistics.

double	getEstimatedPeriod () const
	Return estimated period since last reset.

void	getEstimatedPeriod (double &av, double &std) const
	Return estimated period since last reset.

unsigned int	getIterations () const
	Return the number of iterations performed since last reset.

double	getEstimatedUsed () const
	Return the estimated duration of the run() function since last reset.

void	getEstimatedUsed (double &av, double &std) const
	Return estimated duration of the run() function since last reset.

int	setPriority (int priority, int policy=-1)
	Set the priority and scheduling policy of the thread, if the OS supports that.

int	getPriority () const
	Query the current priority of the thread, if the OS supports that.

int	getPolicy () const
	Query the current scheduling policy of the thread, if the OS supports that.

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

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 DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.

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 MultipleAnalogSensorsMetadata
	MultipleAnalogSensorsMetadata ()

virtual std::vector< std::string >	help (const std::string &functionName="--all")

bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.

Public Member Functions inherited from yarp::os::Wire
yarp::os::WireLink &	yarp ()
	Get YARP state associated with this object.

const yarp::os::WireLink &	yarp () const
	Get YARP state associated with this object (const version).

Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.

virtual Type	getReadType () const

Public Member Functions inherited from MultipleAnalogSensorsServer_ParamsParser
	MultipleAnalogSensorsServer_ParamsParser ()

	~MultipleAnalogSensorsServer_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
Public Attributes inherited from MultipleAnalogSensorsServer_ParamsParser
const std::string	m_device_classname = {"MultipleAnalogSensorsServer"}

const std::string	m_device_name = {"multipleanalogsensorsserver"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_name_defaultValue = {""}

const std::string	m_period_defaultValue = {""}

std::string	m_name = {}

int	m_period = {0}

Protected Member Functions inherited from yarp::os::PeriodicThread
virtual bool	threadInit ()
	Initialization method.

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().

Detailed Description

multipleanalogsensorsserver: The server side of the MultipleAnalogSensorsClient, useful to expose device implementing MultipleAnalogSensors interfaces over the YARP network.

This device opens two ports: /${name}/measures:o that streams the data of the sensors, and /${name}/rpc:o that is a YARP RPC port that exposes the metadata. The data on the /${name}/measures:o is streamed every ${period} milliseconds, and an envelope to each data is added with a timestamp obtained by calling the yarp::os::Time::now() method when the message is written on the port.

Parameters required by this device are shown in class: MultipleAnalogSensorsServer_ParamsParser

Definition at line 33 of file MultipleAnalogSensorsServer.h.

Constructor & Destructor Documentation

◆ MultipleAnalogSensorsServer()

MultipleAnalogSensorsServer::MultipleAnalogSensorsServer ( )

Definition at line 114 of file MultipleAnalogSensorsServer.cpp.

◆ ~MultipleAnalogSensorsServer()

MultipleAnalogSensorsServer::~MultipleAnalogSensorsServer ( )

default

Member Function Documentation

◆ attach()

bool MultipleAnalogSensorsServer::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 368 of file MultipleAnalogSensorsServer.cpp.

◆ close()

bool MultipleAnalogSensorsServer::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 148 of file MultipleAnalogSensorsServer.cpp.

◆ detach()

bool MultipleAnalogSensorsServer::detach ( )

overridevirtual

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

Returns: true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 441 of file MultipleAnalogSensorsServer.cpp.

◆ getMetadata()

SensorRPCData MultipleAnalogSensorsServer::getMetadata ( )

overridevirtual

Read the sensor metadata necessary to configure the MultipleAnalogSensorsClient device.

Reimplemented from MultipleAnalogSensorsMetadata.

Definition at line 456 of file MultipleAnalogSensorsServer.cpp.

◆ open()

bool MultipleAnalogSensorsServer::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 121 of file MultipleAnalogSensorsServer.cpp.

◆ run()

void MultipleAnalogSensorsServer::run ( )

overridevirtual

Loop function.

This is the thread itself. The thread calls the run() function every <period> ms. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the run() function take 3ms to be executed, the thread will sleep for 7ms.

Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.

Implements yarp::os::PeriodicThread.

Definition at line 494 of file MultipleAnalogSensorsServer.cpp.

◆ threadRelease()

void MultipleAnalogSensorsServer::threadRelease ( )

overridevirtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented from yarp::os::PeriodicThread.

Definition at line 587 of file MultipleAnalogSensorsServer.cpp.

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

src/devices/networkWrappers/multipleanalogsensorsserver/MultipleAnalogSensorsServer.h
src/devices/networkWrappers/multipleanalogsensorsserver/MultipleAnalogSensorsServer.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MultipleAnalogSensorsServer()

◆ ~MultipleAnalogSensorsServer()

Member Function Documentation

◆ attach()

◆ close()

◆ detach()

◆ getMetadata()

◆ open()

◆ run()

◆ threadRelease()