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

#include <messages/frameGrabberMsgs/idl_generated_code/IFrameGrabberControlMsgs_return_getActive.h>

+ Inheritance diagram for IFrameGrabberControlMsgs_return_getActive:

Public Types

typedef yarp::os::idl::Unwrapped< IFrameGrabberControlMsgs_return_getActiveunwrapped
 
typedef yarp::os::idl::Unwrapped< IFrameGrabberControlMsgs_return_getActiveunwrapped
 

Public Member Functions

 IFrameGrabberControlMsgs_return_getActive ()=default
 
 IFrameGrabberControlMsgs_return_getActive (const yarp::dev::ReturnValue &ret, const bool isActive)
 
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
 
 IFrameGrabberControlMsgs_return_getActive ()=default
 
 IFrameGrabberControlMsgs_return_getActive (const yarp::dev::ReturnValue &ret, const bool isActive)
 
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 {}
 
bool isActive {false}
 

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 IFrameGrabberControlMsgs_return_getActive.h.

Member Typedef Documentation

◆ unwrapped [1/2]

◆ unwrapped [2/2]

Constructor & Destructor Documentation

◆ IFrameGrabberControlMsgs_return_getActive() [1/4]

IFrameGrabberControlMsgs_return_getActive::IFrameGrabberControlMsgs_return_getActive ( )
default

◆ IFrameGrabberControlMsgs_return_getActive() [2/4]

IFrameGrabberControlMsgs_return_getActive::IFrameGrabberControlMsgs_return_getActive ( const yarp::dev::ReturnValue ret,
const bool  isActive 
)

◆ IFrameGrabberControlMsgs_return_getActive() [3/4]

IFrameGrabberControlMsgs_return_getActive::IFrameGrabberControlMsgs_return_getActive ( )
default

◆ IFrameGrabberControlMsgs_return_getActive() [4/4]

IFrameGrabberControlMsgs_return_getActive::IFrameGrabberControlMsgs_return_getActive ( const yarp::dev::ReturnValue ret,
const bool  isActive 
)

Member Function Documentation

◆ read() [1/4]

bool IFrameGrabberControlMsgs_return_getActive::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 38 of file IFrameGrabberControlMsgs_return_getActive.cpp.

◆ read() [2/4]

bool IFrameGrabberControlMsgs_return_getActive::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.

◆ read() [3/4]

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

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

Definition at line 23 of file IFrameGrabberControlMsgs_return_getActive.cpp.

◆ read() [4/4]

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

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

◆ toString() [1/2]

std::string IFrameGrabberControlMsgs_return_getActive::toString ( ) const

◆ toString() [2/2]

std::string IFrameGrabberControlMsgs_return_getActive::toString ( ) const

◆ write() [1/4]

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

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

Definition at line 51 of file IFrameGrabberControlMsgs_return_getActive.cpp.

◆ write() [2/4]

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

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

◆ write() [3/4]

bool IFrameGrabberControlMsgs_return_getActive::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 66 of file IFrameGrabberControlMsgs_return_getActive.cpp.

◆ write() [4/4]

bool IFrameGrabberControlMsgs_return_getActive::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.

Member Data Documentation

◆ isActive

bool IFrameGrabberControlMsgs_return_getActive::isActive {false}

Definition at line 24 of file IFrameGrabberControlMsgs_return_getActive.h.

◆ ret

yarp::dev::ReturnValue IFrameGrabberControlMsgs_return_getActive::ret {}

Definition at line 23 of file IFrameGrabberControlMsgs_return_getActive.h.


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