YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::os::PortCoreMsgs_setConnectionParamsIn_helper Class Reference
+ Inheritance diagram for yarp::os::PortCoreMsgs_setConnectionParamsIn_helper:

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = return_setConnectionParams(*)(const std::string &, const std::string &)
 

Public Member Functions

 PortCoreMsgs_setConnectionParamsIn_helper ()=default
 
 PortCoreMsgs_setConnectionParamsIn_helper (const std::string &portname, const std::string &params)
 
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 (PortCoreMsgs *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 {"setConnectionParamsIn"}
 
static constexpr size_t s_tag_len {1}
 
static constexpr size_t s_cmd_len {3}
 
static constexpr size_t s_reply_len {3}
 
static constexpr const char * s_prototype {"return_setConnectionParams PortCoreMsgs::setConnectionParamsIn(const std::string& portname, const std::string& params)"}
 
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 829 of file PortCoreMsgs.cpp.

Member Typedef Documentation

◆ funcptr_t

Constructor & Destructor Documentation

◆ PortCoreMsgs_setConnectionParamsIn_helper() [1/2]

yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::PortCoreMsgs_setConnectionParamsIn_helper ( )
default

◆ PortCoreMsgs_setConnectionParamsIn_helper() [2/2]

yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::PortCoreMsgs_setConnectionParamsIn_helper ( const std::string &  portname,
const std::string &  params 
)

Definition at line 3388 of file PortCoreMsgs.cpp.

Member Function Documentation

◆ call()

void yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::call ( PortCoreMsgs *  ptr)

Definition at line 3548 of file PortCoreMsgs.cpp.

◆ read()

bool yarp::os::PortCoreMsgs_setConnectionParamsIn_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 3398 of file PortCoreMsgs.cpp.

◆ write()

bool yarp::os::PortCoreMsgs_setConnectionParamsIn_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 3393 of file PortCoreMsgs.cpp.

Member Data Documentation

◆ cmd

Command yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::cmd

Definition at line 881 of file PortCoreMsgs.cpp.

◆ reply

Reply yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::reply

Definition at line 882 of file PortCoreMsgs.cpp.

◆ s_cmd_len

constexpr size_t yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::s_cmd_len {3}
staticconstexpr

Definition at line 886 of file PortCoreMsgs.cpp.

◆ s_help

constexpr const char* yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::s_help
staticconstexpr
Initial value:
{
"Set the carrier parameters of the input connection coming from another port to this port.\n"
"@param portname the source port of the connection\n"
"@param params the parameters, in yarp::os::Property format; their meaning depends on the carrier of the connection\n"
"@return success: false if there is no such connection; message: a description of the result"
}

Definition at line 889 of file PortCoreMsgs.cpp.

◆ s_prototype

constexpr const char* yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::s_prototype {"return_setConnectionParams PortCoreMsgs::setConnectionParamsIn(const std::string& portname, const std::string& params)"}
staticconstexpr

Definition at line 888 of file PortCoreMsgs.cpp.

◆ s_reply_len

constexpr size_t yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::s_reply_len {3}
staticconstexpr

Definition at line 887 of file PortCoreMsgs.cpp.

◆ s_tag

constexpr const char* yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::s_tag {"setConnectionParamsIn"}
staticconstexpr

Definition at line 884 of file PortCoreMsgs.cpp.

◆ s_tag_len

constexpr size_t yarp::os::PortCoreMsgs_setConnectionParamsIn_helper::s_tag_len {1}
staticconstexpr

Definition at line 885 of file PortCoreMsgs.cpp.


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