yarprobotinterfaceRpc Class Reference

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/commands/yarprobotinterface/idl_generated_code/yarprobotinterfaceRpc.h>

Inheritance diagram for yarprobotinterfaceRpc:

Public Member Functions
virtual yarp::os::ApplicationNetworkProtocolVersion	getLocalProtocolVersion ()
virtual yarp::os::ApplicationNetworkProtocolVersion	getRemoteProtocolVersion ()
virtual bool	checkProtocolVersion ()
	yarprobotinterfaceRpc ()
virtual std::string	get_phase ()
	Returns current phase.
virtual std::int32_t	get_level ()
	Returns current level.
virtual std::string	get_robot ()
	Returns robot name.
virtual bool	is_ready ()
	Returns true if yarprobotinterface is ready (all startup actions performed and no interrupt called).
virtual std::string	quit ()
	Closes yarprobotinterface.
virtual std::string	bye ()
	Closes yarprobotinterface.
virtual std::string	exit ()
	Closes yarprobotinterface.
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

Detailed Description

Definition at line 18 of file yarprobotinterfaceRpc.h.

Constructor & Destructor Documentation

yarprobotinterfaceRpc()

yarprobotinterfaceRpc::yarprobotinterfaceRpc

(

)

Definition at line 1461 of file yarprobotinterfaceRpc.cpp.

Member Function Documentation

bye()

std::string yarprobotinterfaceRpc::bye ( )

virtual

Closes yarprobotinterface.

Reimplemented in yarprobotinterface::Module.

Definition at line 1516 of file yarprobotinterfaceRpc.cpp.

checkProtocolVersion()

bool yarprobotinterfaceRpc::checkProtocolVersion ( )

virtual

Definition at line 80 of file yarprobotinterfaceRpc.cpp.

exit()

std::string yarprobotinterfaceRpc::exit ( )

virtual

Closes yarprobotinterface.

Reimplemented in yarprobotinterface::Module.

Definition at line 1526 of file yarprobotinterfaceRpc.cpp.

get_level()

std::int32_t yarprobotinterfaceRpc::get_level ( )

virtual

Returns current level.

Reimplemented in yarprobotinterface::Module.

Definition at line 1476 of file yarprobotinterfaceRpc.cpp.

get_phase()

std::string yarprobotinterfaceRpc::get_phase ( )

virtual

Returns current phase.

Reimplemented in yarprobotinterface::Module.

Definition at line 1466 of file yarprobotinterfaceRpc.cpp.

get_robot()

std::string yarprobotinterfaceRpc::get_robot ( )

virtual

Returns robot name.

Reimplemented in yarprobotinterface::Module.

Definition at line 1486 of file yarprobotinterfaceRpc.cpp.

getLocalProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarprobotinterfaceRpc::getLocalProtocolVersion ( )

virtual

Definition at line 95 of file yarprobotinterfaceRpc.cpp.

getRemoteProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarprobotinterfaceRpc::getRemoteProtocolVersion ( )

virtual

Definition at line 65 of file yarprobotinterfaceRpc.cpp.

help()

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

virtual

Definition at line 1537 of file yarprobotinterfaceRpc.cpp.

is_ready()

bool yarprobotinterfaceRpc::is_ready ( )

virtual

Returns true if yarprobotinterface is ready (all startup actions performed and no interrupt called).

Reimplemented in yarprobotinterface::Module.

Definition at line 1496 of file yarprobotinterfaceRpc.cpp.

quit()

std::string yarprobotinterfaceRpc::quit ( )

virtual

Closes yarprobotinterface.

Reimplemented in yarprobotinterface::Module.

Definition at line 1506 of file yarprobotinterfaceRpc.cpp.

read()

bool yarprobotinterfaceRpc::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 1594 of file yarprobotinterfaceRpc.cpp.

---

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

• src/commands/yarprobotinterface/idl_generated_code/yarprobotinterfaceRpc.h
• src/commands/yarprobotinterface/idl_generated_code/yarprobotinterfaceRpc.cpp