YARP
Yet Another Robot Platform
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
IMap2DMsgs_store_path_RPC_helper Class Reference
+ Inheritance diagram for IMap2DMsgs_store_path_RPC_helper:

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = bool(*)(const std::string &, const yarp::dev::Nav2D::Map2DPath &)
 

Public Member Functions

 IMap2DMsgs_store_path_RPC_helper ()=default
 
 IMap2DMsgs_store_path_RPC_helper (const std::string &path_name, const yarp::dev::Nav2D::Map2DPath &path)
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
void call (IMap2DMsgs *ptr)
 
- Public Member Functions inherited from yarp::os::Portable
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

Command cmd
 
Reply reply
 

Static Public Attributes

static constexpr const char * s_tag {"store_path_RPC"}
 
static constexpr size_t s_tag_len {3}
 
static constexpr size_t s_cmd_len {5}
 
static constexpr size_t s_reply_len {1}
 
static constexpr const char * s_prototype {"bool IMap2DMsgs::store_path_RPC(const std::string& path_name, const yarp::dev::Nav2D::Map2DPath& path)"}
 
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. More...
 

Detailed Description

Definition at line 451 of file IMap2DMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

using IMap2DMsgs_store_path_RPC_helper::funcptr_t = bool (*)(const std::string&, const yarp::dev::Nav2D::Map2DPath&)

Definition at line 500 of file IMap2DMsgs.cpp.

Constructor & Destructor Documentation

◆ IMap2DMsgs_store_path_RPC_helper() [1/2]

IMap2DMsgs_store_path_RPC_helper::IMap2DMsgs_store_path_RPC_helper ( )
default

◆ IMap2DMsgs_store_path_RPC_helper() [2/2]

IMap2DMsgs_store_path_RPC_helper::IMap2DMsgs_store_path_RPC_helper ( const std::string &  path_name,
const yarp::dev::Nav2D::Map2DPath &  path 
)

Definition at line 3230 of file IMap2DMsgs.cpp.

Member Function Documentation

◆ call()

void IMap2DMsgs_store_path_RPC_helper::call ( IMap2DMsgs *  ptr)

Definition at line 3390 of file IMap2DMsgs.cpp.

◆ read()

bool IMap2DMsgs_store_path_RPC_helper::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 3240 of file IMap2DMsgs.cpp.

◆ write()

bool IMap2DMsgs_store_path_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
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 3235 of file IMap2DMsgs.cpp.

Member Data Documentation

◆ cmd

Command IMap2DMsgs_store_path_RPC_helper::cmd

Definition at line 503 of file IMap2DMsgs.cpp.

◆ reply

Reply IMap2DMsgs_store_path_RPC_helper::reply

Definition at line 504 of file IMap2DMsgs.cpp.

◆ s_cmd_len

constexpr size_t IMap2DMsgs_store_path_RPC_helper::s_cmd_len {5}
staticconstexpr

Definition at line 508 of file IMap2DMsgs.cpp.

◆ s_help

constexpr const char* IMap2DMsgs_store_path_RPC_helper::s_help {""}
staticconstexpr

Definition at line 511 of file IMap2DMsgs.cpp.

◆ s_prototype

constexpr const char* IMap2DMsgs_store_path_RPC_helper::s_prototype {"bool IMap2DMsgs::store_path_RPC(const std::string& path_name, const yarp::dev::Nav2D::Map2DPath& path)"}
staticconstexpr

Definition at line 510 of file IMap2DMsgs.cpp.

◆ s_reply_len

constexpr size_t IMap2DMsgs_store_path_RPC_helper::s_reply_len {1}
staticconstexpr

Definition at line 509 of file IMap2DMsgs.cpp.

◆ s_tag

constexpr const char* IMap2DMsgs_store_path_RPC_helper::s_tag {"store_path_RPC"}
staticconstexpr

Definition at line 506 of file IMap2DMsgs.cpp.

◆ s_tag_len

constexpr size_t IMap2DMsgs_store_path_RPC_helper::s_tag_len {3}
staticconstexpr

Definition at line 507 of file IMap2DMsgs.cpp.

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