INavigation2DMsgs_apply_velocity_command_RPC_helper Class Reference

Inheritance diagram for INavigation2DMsgs_apply_velocity_command_RPC_helper:

Classes
class	Command
class	Reply

Public Types
using	funcptr_t = yarp::dev::ReturnValue(*)(const double, const double, const double, const double)

Public Member Functions
	INavigation2DMsgs_apply_velocity_command_RPC_helper ()=default
	INavigation2DMsgs_apply_velocity_command_RPC_helper (const double x_vel, const double y_vel, const double theta_vel, const double timeout)
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection.
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
void	call (INavigation2DMsgs *ptr)
Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
virtual Type	getReadType () const
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.
virtual void	onCompletion () const
	This is called when the port has finished all writing operations.
virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.
virtual yarp::os::Type	getWriteType () const

Public Attributes
Command	cmd
Reply	reply

Static Public Attributes
static constexpr const char *	s_tag {"apply_velocity_command_RPC"}
static constexpr size_t	s_tag_len {4}
static constexpr size_t	s_cmd_len {8}
static constexpr size_t	s_reply_len {1}
static constexpr const char *	s_prototype {"yarp::dev::ReturnValue INavigation2DMsgs::apply_velocity_command_RPC(const double x_vel, const double y_vel, const double theta_vel, const double timeout)"}
static constexpr const char *	s_help {""}

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

Definition at line 932 of file INavigation2DMsgs.cpp.

Member Typedef Documentation

funcptr_t

using INavigation2DMsgs_apply_velocity_command_RPC_helper::funcptr_t = yarp::dev::ReturnValue (*)(const double, const double, const double, const double)

Definition at line 983 of file INavigation2DMsgs.cpp.

Constructor & Destructor Documentation

INavigation2DMsgs_apply_velocity_command_RPC_helper() [1/2]

INavigation2DMsgs_apply_velocity_command_RPC_helper::INavigation2DMsgs_apply_velocity_command_RPC_helper ( )

default

INavigation2DMsgs_apply_velocity_command_RPC_helper() [2/2]

INavigation2DMsgs_apply_velocity_command_RPC_helper::INavigation2DMsgs_apply_velocity_command_RPC_helper	(	const double	x_vel,
		const double	y_vel,
		const double	theta_vel,
		const double	timeout
	)

Definition at line 3275 of file INavigation2DMsgs.cpp.

Member Function Documentation

call()

void INavigation2DMsgs_apply_velocity_command_RPC_helper::call

(

INavigation2DMsgs *

ptr

)

Definition at line 3453 of file INavigation2DMsgs.cpp.

read()

bool INavigation2DMsgs_apply_velocity_command_RPC_helper::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::Portable.

Definition at line 3285 of file INavigation2DMsgs.cpp.

write()

bool INavigation2DMsgs_apply_velocity_command_RPC_helper::write ( yarp::os::ConnectionWriter &  writer ) const

overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 3280 of file INavigation2DMsgs.cpp.

Member Data Documentation

cmd

Command INavigation2DMsgs_apply_velocity_command_RPC_helper::cmd

Definition at line 986 of file INavigation2DMsgs.cpp.

reply

Reply INavigation2DMsgs_apply_velocity_command_RPC_helper::reply

Definition at line 987 of file INavigation2DMsgs.cpp.

s_cmd_len

constexpr size_t INavigation2DMsgs_apply_velocity_command_RPC_helper::s_cmd_len {8}

staticconstexpr

Definition at line 991 of file INavigation2DMsgs.cpp.

s_help

constexpr const char* INavigation2DMsgs_apply_velocity_command_RPC_helper::s_help {""}

staticconstexpr

Definition at line 994 of file INavigation2DMsgs.cpp.

s_prototype

constexpr const char* INavigation2DMsgs_apply_velocity_command_RPC_helper::s_prototype {"yarp::dev::ReturnValue INavigation2DMsgs::apply_velocity_command_RPC(const double x_vel, const double y_vel, const double theta_vel, const double timeout)"}

staticconstexpr

Definition at line 993 of file INavigation2DMsgs.cpp.

s_reply_len

constexpr size_t INavigation2DMsgs_apply_velocity_command_RPC_helper::s_reply_len {1}

staticconstexpr

Definition at line 992 of file INavigation2DMsgs.cpp.

s_tag

constexpr const char* INavigation2DMsgs_apply_velocity_command_RPC_helper::s_tag {"apply_velocity_command_RPC"}

staticconstexpr

Definition at line 989 of file INavigation2DMsgs.cpp.

s_tag_len

constexpr size_t INavigation2DMsgs_apply_velocity_command_RPC_helper::s_tag_len {4}

staticconstexpr

Definition at line 990 of file INavigation2DMsgs.cpp.

---

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

• src/devices/messages/INavigation2DMsgs/idl_generated_code/INavigation2DMsgs.cpp