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

#include <IAudioGrabberMsgs/idl_generated_code/return_getRecordingAudioBufferCurrentSize.h>

+ Inheritance diagram for return_getRecordingAudioBufferCurrentSize:

Public Types

typedef yarp::os::idl::Unwrapped< return_getRecordingAudioBufferCurrentSizeunwrapped
 

Public Member Functions

 return_getRecordingAudioBufferCurrentSize ()=default
 
 return_getRecordingAudioBufferCurrentSize (const bool ret, const yarp::dev::AudioBufferSize &bufsize)
 
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

bool ret {false}
 
yarp::dev::AudioBufferSize bufsize {}
 

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 20 of file return_getRecordingAudioBufferCurrentSize.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ return_getRecordingAudioBufferCurrentSize() [1/2]

return_getRecordingAudioBufferCurrentSize::return_getRecordingAudioBufferCurrentSize ( )
default

◆ return_getRecordingAudioBufferCurrentSize() [2/2]

return_getRecordingAudioBufferCurrentSize::return_getRecordingAudioBufferCurrentSize ( const bool  ret,
const yarp::dev::AudioBufferSize bufsize 
)

Member Function Documentation

◆ read() [1/2]

bool return_getRecordingAudioBufferCurrentSize::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 return_getRecordingAudioBufferCurrentSize.cpp.

◆ read() [2/2]

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

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

Definition at line 23 of file return_getRecordingAudioBufferCurrentSize.cpp.

◆ toString()

std::string return_getRecordingAudioBufferCurrentSize::toString ( ) const

◆ write() [1/2]

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

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

Definition at line 51 of file return_getRecordingAudioBufferCurrentSize.cpp.

◆ write() [2/2]

bool return_getRecordingAudioBufferCurrentSize::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 return_getRecordingAudioBufferCurrentSize.cpp.

Member Data Documentation

◆ bufsize

yarp::dev::AudioBufferSize return_getRecordingAudioBufferCurrentSize::bufsize {}

Definition at line 26 of file return_getRecordingAudioBufferCurrentSize.h.

◆ ret

bool return_getRecordingAudioBufferCurrentSize::ret {false}

Definition at line 25 of file return_getRecordingAudioBufferCurrentSize.h.


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