YARP
Yet Another Robot Platform
return_get_rel_loc_of_curr_target Class Reference

#include <INavigation2DMsgs/idl_generated_code/return_get_rel_loc_of_curr_target.h>

+ Inheritance diagram for return_get_rel_loc_of_curr_target:

Public Types

typedef yarp::os::idl::Unwrapped< return_get_rel_loc_of_curr_targetunwrapped
 

Public Member Functions

 return_get_rel_loc_of_curr_target ()=default
 
 return_get_rel_loc_of_curr_target (const bool ret, const double x, const double y, const double theta)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
std::string toString () const
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool read (yarp::os::idl::WireReader &reader)
 
virtual bool write (const yarp::os::idl::WireWriter &writer) const
 
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- 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

bool ret {false}
 
double x {0.0}
 
double y {0.0}
 
double theta {0.0}
 

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 17 of file return_get_rel_loc_of_curr_target.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ return_get_rel_loc_of_curr_target() [1/2]

return_get_rel_loc_of_curr_target::return_get_rel_loc_of_curr_target ( )
default

◆ return_get_rel_loc_of_curr_target() [2/2]

return_get_rel_loc_of_curr_target::return_get_rel_loc_of_curr_target ( const bool  ret,
const double  x,
const double  y,
const double  theta 
)

Definition at line 14 of file return_get_rel_loc_of_curr_target.cpp.

Member Function Documentation

◆ read() [1/2]

bool return_get_rel_loc_of_curr_target::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 48 of file return_get_rel_loc_of_curr_target.cpp.

◆ read() [2/2]

bool return_get_rel_loc_of_curr_target::read ( yarp::os::idl::WireReader reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 27 of file return_get_rel_loc_of_curr_target.cpp.

◆ toString()

std::string return_get_rel_loc_of_curr_target::toString ( ) const

Definition at line 95 of file return_get_rel_loc_of_curr_target.cpp.

◆ write() [1/2]

bool return_get_rel_loc_of_curr_target::write ( const yarp::os::idl::WireWriter writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 61 of file return_get_rel_loc_of_curr_target.cpp.

◆ write() [2/2]

bool return_get_rel_loc_of_curr_target::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 82 of file return_get_rel_loc_of_curr_target.cpp.

Member Data Documentation

◆ ret

bool return_get_rel_loc_of_curr_target::ret {false}

Definition at line 22 of file return_get_rel_loc_of_curr_target.h.

◆ theta

double return_get_rel_loc_of_curr_target::theta {0.0}

Definition at line 25 of file return_get_rel_loc_of_curr_target.h.

◆ x

double return_get_rel_loc_of_curr_target::x {0.0}

Definition at line 23 of file return_get_rel_loc_of_curr_target.h.

◆ y

double return_get_rel_loc_of_curr_target::y {0.0}

Definition at line 24 of file return_get_rel_loc_of_curr_target.h.


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