YARP
Yet Another Robot Platform
yarp::dev::audioBufferSizeData Class Reference

#include <yarp/dev/audioBufferSizeData.h>

+ Inheritance diagram for yarp::dev::audioBufferSizeData:

Classes

class  Editor
 

Public Types

typedef yarp::os::idl::Unwrapped< audioBufferSizeDataunwrapped
 

Public Member Functions

 audioBufferSizeData ()
 
 audioBufferSizeData (const std::int32_t m_samples, const std::int32_t m_channels, const std::int32_t m_depth, const std::int32_t size)
 
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 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. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. 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

std::int32_t m_samples
 
std::int32_t m_channels
 
std::int32_t m_depth
 
std::int32_t size
 

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 22 of file audioBufferSizeData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ audioBufferSizeData() [1/2]

yarp::dev::audioBufferSizeData::audioBufferSizeData ( )

Definition at line 17 of file audioBufferSizeData.cpp.

◆ audioBufferSizeData() [2/2]

yarp::dev::audioBufferSizeData::audioBufferSizeData ( const std::int32_t  m_samples,
const std::int32_t  m_channels,
const std::int32_t  m_depth,
const std::int32_t  size 
)

Definition at line 27 of file audioBufferSizeData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::dev::audioBufferSizeData::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.

Reimplemented in yarp::dev::AudioBufferSize.

Definition at line 58 of file audioBufferSizeData.cpp.

◆ read() [2/2]

bool yarp::dev::audioBufferSizeData::read ( yarp::os::idl::WireReader reader)
overridevirtual

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

Reimplemented in yarp::dev::AudioBufferSize.

Definition at line 40 of file audioBufferSizeData.cpp.

◆ toString()

std::string yarp::dev::audioBufferSizeData::toString ( ) const

Definition at line 96 of file audioBufferSizeData.cpp.

◆ write() [1/2]

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

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

Reimplemented in yarp::dev::AudioBufferSize.

Definition at line 68 of file audioBufferSizeData.cpp.

◆ write() [2/2]

bool yarp::dev::audioBufferSizeData::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.

Reimplemented in yarp::dev::AudioBufferSize.

Definition at line 86 of file audioBufferSizeData.cpp.

Member Data Documentation

◆ m_channels

std::int32_t yarp::dev::audioBufferSizeData::m_channels

Definition at line 28 of file audioBufferSizeData.h.

◆ m_depth

std::int32_t yarp::dev::audioBufferSizeData::m_depth

Definition at line 29 of file audioBufferSizeData.h.

◆ m_samples

std::int32_t yarp::dev::audioBufferSizeData::m_samples

Definition at line 27 of file audioBufferSizeData.h.

◆ size

std::int32_t yarp::dev::audioBufferSizeData::size

Definition at line 30 of file audioBufferSizeData.h.


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