ControlBoardMsgs_setAutoBrakeEnabledRPC_helper Class Reference

Inheritance diagram for ControlBoardMsgs_setAutoBrakeEnabledRPC_helper:

Classes
class	Command
class	Reply

Public Types
using	funcptr_t = yarp::dev::ReturnValue(*)(const std::int32_t, const bool)

Public Member Functions
	ControlBoardMsgs_setAutoBrakeEnabledRPC_helper ()=default
	ControlBoardMsgs_setAutoBrakeEnabledRPC_helper (const std::int32_t j, const bool enabled)
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 (ControlBoardMsgs *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 {"setAutoBrakeEnabledRPC"}
static constexpr size_t	s_tag_len {1}
static constexpr size_t	s_cmd_len {3}
static constexpr size_t	s_reply_len {1}
static constexpr const char *	s_prototype {"yarp::dev::ReturnValue ControlBoardMsgs::setAutoBrakeEnabledRPC(const std::int32_t j, const bool enabled)"}
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 236 of file ControlBoardMsgs.cpp.

Member Typedef Documentation

funcptr_t

using ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::funcptr_t = yarp::dev::ReturnValue (*)(const std::int32_t, const bool)

Definition at line 285 of file ControlBoardMsgs.cpp.

Constructor & Destructor Documentation

ControlBoardMsgs_setAutoBrakeEnabledRPC_helper() [1/2]

ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::ControlBoardMsgs_setAutoBrakeEnabledRPC_helper ( )

default

ControlBoardMsgs_setAutoBrakeEnabledRPC_helper() [2/2]

ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::ControlBoardMsgs_setAutoBrakeEnabledRPC_helper	(	const std::int32_t	j,
		const bool	enabled
	)

Definition at line 919 of file ControlBoardMsgs.cpp.

Member Function Documentation

call()

void ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::call

(

ControlBoardMsgs *

ptr

)

Definition at line 1073 of file ControlBoardMsgs.cpp.

read()

bool ControlBoardMsgs_setAutoBrakeEnabledRPC_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 929 of file ControlBoardMsgs.cpp.

write()

bool ControlBoardMsgs_setAutoBrakeEnabledRPC_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 924 of file ControlBoardMsgs.cpp.

Member Data Documentation

cmd

Command ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::cmd

Definition at line 288 of file ControlBoardMsgs.cpp.

reply

Reply ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::reply

Definition at line 289 of file ControlBoardMsgs.cpp.

s_cmd_len

constexpr size_t ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::s_cmd_len {3}

staticconstexpr

Definition at line 293 of file ControlBoardMsgs.cpp.

s_help

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

staticconstexpr

Definition at line 296 of file ControlBoardMsgs.cpp.

s_prototype

constexpr const char* ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::s_prototype {"yarp::dev::ReturnValue ControlBoardMsgs::setAutoBrakeEnabledRPC(const std::int32_t j, const bool enabled)"}

staticconstexpr

Definition at line 295 of file ControlBoardMsgs.cpp.

s_reply_len

constexpr size_t ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::s_reply_len {1}

staticconstexpr

Definition at line 294 of file ControlBoardMsgs.cpp.

s_tag

constexpr const char* ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::s_tag {"setAutoBrakeEnabledRPC"}

staticconstexpr

Definition at line 291 of file ControlBoardMsgs.cpp.

s_tag_len

constexpr size_t ControlBoardMsgs_setAutoBrakeEnabledRPC_helper::s_tag_len {1}

staticconstexpr

Definition at line 292 of file ControlBoardMsgs.cpp.

---

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

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