navigation2DServer: Documentation to be added More...

#include <navigation2DServer/navigation2DServer.h>

Inheritance diagram for navigation2DServer:

Public Member Functions
	navigation2DServer ()
	Default module constructor. More...

virtual bool	open (yarp::os::Searchable &prop) override
	Open the DeviceDriver. More...

virtual bool	close () override
	Close the DeviceDriver. More...

virtual bool	detachAll () override
	Detach the object (you must have first called attach). More...

virtual bool	attachAll (const yarp::dev::PolyDriverList &l) override
	Attach to a list of objects. More...

virtual void	run () override
	Loop function. More...

bool	initialize_YARP (yarp::os::Searchable &config)

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

Public Member Functions inherited from yarp::dev::DeviceDriver
	~DeviceDriver () override=default
	Destructor. More...

template<class T >
bool	view (T *&x)
	Get an interface to the device driver. More...

virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others. More...

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

virtual bool	configure (Searchable &config)
	Change online parameters. More...

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

virtual	~PeriodicThread ()

bool	start ()
	Call this to start the thread. More...

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

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

void	askToStop ()
	Stop the thread. More...

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

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

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

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

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

void	resume ()
	Resume the thread if previously suspended. More...

void	resetStat ()
	Reset thread statistics. More...

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

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

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

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

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

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

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

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

Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual	~IMultipleWrapper ()
	Destructor. More...

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

virtual Type	getReadType () const

Protected Attributes
yarp::os::Port	m_rpcPort

std::string	m_rpcPortName

std::string	m_streamingPortName

std::string	m_yarpviewPortName

yarp::dev::Nav2D::NavigationStatusEnum	m_navigation_status

yarp::dev::PolyDriver	pNav

yarp::dev::Nav2D::INavigation2DControlActions *	iNav_ctrl

yarp::dev::Nav2D::INavigation2DTargetActions *	iNav_target

double	m_period

double	m_stats_time_last

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

virtual void	threadRelease ()
	Release method. More...

virtual void	beforeStart ()
	Called just before a new thread starts. More...

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

Detailed Description

navigation2DServer: Documentation to be added

Definition at line 42 of file navigation2DServer.h.

Constructor & Destructor Documentation

◆ navigation2DServer()

navigation2DServer::navigation2DServer ( )

Default module constructor.

Definition at line 47 of file navigation2DServer.cpp.

Member Function Documentation

◆ attachAll()

bool navigation2DServer::attachAll ( const yarp::dev::PolyDriverList & p )

overridevirtual

Attach to a list of objects.

Parameters

p	the polydriver list that you want to attach to.

Returns: true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 54 of file navigation2DServer.cpp.

◆ close()

bool navigation2DServer::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 162 of file navigation2DServer.cpp.

◆ detachAll()

bool navigation2DServer::detachAll ( )

overridevirtual

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

Returns: true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 81 of file navigation2DServer.cpp.

◆ initialize_YARP()

bool navigation2DServer::initialize_YARP ( yarp::os::Searchable & config )

Definition at line 151 of file navigation2DServer.cpp.

◆ open()

bool navigation2DServer::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 92 of file navigation2DServer.cpp.

◆ read()

bool navigation2DServer::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 475 of file navigation2DServer.cpp.

◆ run()

void navigation2DServer::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 508 of file navigation2DServer.cpp.

Member Data Documentation

◆ iNav_ctrl

yarp::dev::Nav2D::INavigation2DControlActions* navigation2DServer::iNav_ctrl

protected

Definition at line 59 of file navigation2DServer.h.

◆ iNav_target

yarp::dev::Nav2D::INavigation2DTargetActions* navigation2DServer::iNav_target

protected

Definition at line 60 of file navigation2DServer.h.

◆ m_navigation_status

yarp::dev::Nav2D::NavigationStatusEnum navigation2DServer::m_navigation_status

protected

Definition at line 55 of file navigation2DServer.h.

◆ m_period

double navigation2DServer::m_period

protected

Definition at line 62 of file navigation2DServer.h.

◆ m_rpcPort

yarp::os::Port navigation2DServer::m_rpcPort

protected

Definition at line 51 of file navigation2DServer.h.

◆ m_rpcPortName

std::string navigation2DServer::m_rpcPortName

protected

Definition at line 52 of file navigation2DServer.h.

◆ m_stats_time_last

double navigation2DServer::m_stats_time_last

protected

Definition at line 63 of file navigation2DServer.h.

◆ m_streamingPortName

std::string navigation2DServer::m_streamingPortName

protected

Definition at line 53 of file navigation2DServer.h.

◆ m_yarpviewPortName

std::string navigation2DServer::m_yarpviewPortName

protected

Definition at line 54 of file navigation2DServer.h.

◆ pNav

yarp::dev::PolyDriver navigation2DServer::pNav

protected

Definition at line 58 of file navigation2DServer.h.

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

src/devices/navigation2DServer/navigation2DServer.h
src/devices/navigation2DServer/navigation2DServer.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ navigation2DServer()

Member Function Documentation

◆ attachAll()

◆ close()

◆ detachAll()

◆ initialize_YARP()

◆ open()

◆ read()

◆ run()

Member Data Documentation

◆ iNav_ctrl

◆ iNav_target

◆ m_navigation_status

◆ m_period

◆ m_rpcPort

◆ m_rpcPortName

◆ m_stats_time_last

◆ m_streamingPortName

◆ m_yarpviewPortName

◆ pNav