YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
return_getLastJointFault Class Reference

#include <messages/ControlBoardMsgs/idl_generated_code/return_getLastJointFault.h>

+ Inheritance diagram for return_getLastJointFault:

Public Types

typedef yarp::os::idl::Unwrapped< return_getLastJointFault > unwrapped
 

Public Member Functions

 return_getLastJointFault ()=default
 
 return_getLastJointFault (const yarp::dev::ReturnValue &ret, const std::int32_t fault, const std::string &message)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
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.
 
std::string toString () const
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
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
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

yarp::dev::ReturnValue ret {}
 
std::int32_t fault {0}
 
std::string message {}
 

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 18 of file return_getLastJointFault.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ return_getLastJointFault() [1/2]

return_getLastJointFault::return_getLastJointFault ( )
default

◆ return_getLastJointFault() [2/2]

return_getLastJointFault::return_getLastJointFault ( const yarp::dev::ReturnValue &  ret,
const std::int32_t  fault,
const std::string &  message 
)

Definition at line 14 of file return_getLastJointFault.cpp.

Member Function Documentation

◆ read() [1/2]

bool return_getLastJointFault::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 43 of file return_getLastJointFault.cpp.

◆ read() [2/2]

bool return_getLastJointFault::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

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

Definition at line 25 of file return_getLastJointFault.cpp.

◆ toString()

std::string return_getLastJointFault::toString ( ) const

Definition at line 87 of file return_getLastJointFault.cpp.

◆ write() [1/2]

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

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

Definition at line 56 of file return_getLastJointFault.cpp.

◆ write() [2/2]

bool return_getLastJointFault::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 74 of file return_getLastJointFault.cpp.

Member Data Documentation

◆ fault

std::int32_t return_getLastJointFault::fault {0}

Definition at line 24 of file return_getLastJointFault.h.

◆ message

std::string return_getLastJointFault::message {}

Definition at line 25 of file return_getLastJointFault.h.

◆ ret

yarp::dev::ReturnValue return_getLastJointFault::ret {}

Definition at line 23 of file return_getLastJointFault.h.


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