YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
IAudioGrabberMsgs_getSound_RPC_helper::Command Class Reference
+ Inheritance diagram for IAudioGrabberMsgs_getSound_RPC_helper::Command:

Public Member Functions

 Command ()=default
 
 Command (const size_t min_number_of_samples, const size_t max_number_of_samples, const double max_samples_timeout_s)
 
 ~Command () override=default
 
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.
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool writeTag (const yarp::os::idl::WireWriter &writer) const
 
bool writeArgs (const yarp::os::idl::WireWriter &writer) const
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool readTag (yarp::os::idl::WireReader &reader)
 
bool readArgs (yarp::os::idl::WireReader &reader)
 
- 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

size_t min_number_of_samples {0}
 
size_t max_number_of_samples {0}
 
double max_samples_timeout_s {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.
 

Detailed Description

Definition at line 385 of file IAudioGrabberMsgs.cpp.

Constructor & Destructor Documentation

◆ Command() [1/2]

IAudioGrabberMsgs_getSound_RPC_helper::Command::Command ( )
default

◆ Command() [2/2]

IAudioGrabberMsgs_getSound_RPC_helper::Command::Command ( const size_t  min_number_of_samples,
const size_t  max_number_of_samples,
const double  max_samples_timeout_s 
)

Definition at line 1412 of file IAudioGrabberMsgs.cpp.

◆ ~Command()

IAudioGrabberMsgs_getSound_RPC_helper::Command::~Command ( )
overridedefault

Member Function Documentation

◆ read() [1/2]

bool IAudioGrabberMsgs_getSound_RPC_helper::Command::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 1428 of file IAudioGrabberMsgs.cpp.

◆ read() [2/2]

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

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

Definition at line 1471 of file IAudioGrabberMsgs.cpp.

◆ readArgs()

bool IAudioGrabberMsgs_getSound_RPC_helper::Command::readArgs ( yarp::os::idl::WireReader &  reader)

Definition at line 1495 of file IAudioGrabberMsgs.cpp.

◆ readTag()

bool IAudioGrabberMsgs_getSound_RPC_helper::Command::readTag ( yarp::os::idl::WireReader &  reader)

Definition at line 1482 of file IAudioGrabberMsgs.cpp.

◆ write() [1/2]

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

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

Definition at line 1438 of file IAudioGrabberMsgs.cpp.

◆ write() [2/2]

bool IAudioGrabberMsgs_getSound_RPC_helper::Command::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 1419 of file IAudioGrabberMsgs.cpp.

◆ writeArgs()

bool IAudioGrabberMsgs_getSound_RPC_helper::Command::writeArgs ( const yarp::os::idl::WireWriter &  writer) const

Definition at line 1457 of file IAudioGrabberMsgs.cpp.

◆ writeTag()

bool IAudioGrabberMsgs_getSound_RPC_helper::Command::writeTag ( const yarp::os::idl::WireWriter &  writer) const

Definition at line 1449 of file IAudioGrabberMsgs.cpp.

Member Data Documentation

◆ max_number_of_samples

size_t IAudioGrabberMsgs_getSound_RPC_helper::Command::max_number_of_samples {0}

Definition at line 406 of file IAudioGrabberMsgs.cpp.

◆ max_samples_timeout_s

double IAudioGrabberMsgs_getSound_RPC_helper::Command::max_samples_timeout_s {0.0}

Definition at line 407 of file IAudioGrabberMsgs.cpp.

◆ min_number_of_samples

size_t IAudioGrabberMsgs_getSound_RPC_helper::Command::min_number_of_samples {0}

Definition at line 405 of file IAudioGrabberMsgs.cpp.

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