yarp::sig::AudioBufferSize Class Reference

#include <yarp/sig/AudioBufferSize.h>

Inheritance diagram for yarp::sig::AudioBufferSize:

Public Member Functions
size_t	getDepth ()
size_t	getSamples ()
size_t	getChannels ()
size_t	getBufferElements ()
size_t	getBytes ()
bool	read (yarp::os::idl::WireReader &reader) override
bool	write (const yarp::os::idl::WireWriter &writer) const override
bool	read (yarp::os::ConnectionReader &reader) override
	Read this object from a network connection.
bool	write (yarp::os::ConnectionWriter &writer) const override
	Write this object to a network connection.
	AudioBufferSize ()
	AudioBufferSize (size_t samples, size_t channels, size_t depth_in_bytes)
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

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

Constructor & Destructor Documentation

AudioBufferSize() [1/2]

yarp::sig::AudioBufferSize::AudioBufferSize ( )

default

AudioBufferSize() [2/2]

yarp::sig::AudioBufferSize::AudioBufferSize	(	size_t	samples,
		size_t	channels,
		size_t	depth_in_bytes
	)

Definition at line 10 of file AudioBufferSize.cpp.

Member Function Documentation

getBufferElements()

size_t yarp::sig::AudioBufferSize::getBufferElements ( )

inline

Definition at line 30 of file AudioBufferSize.h.

getBytes()

size_t yarp::sig::AudioBufferSize::getBytes ( )

inline

Definition at line 31 of file AudioBufferSize.h.

getChannels()

size_t yarp::sig::AudioBufferSize::getChannels ( )

inline

Definition at line 29 of file AudioBufferSize.h.

getDepth()

size_t yarp::sig::AudioBufferSize::getDepth ( )

inline

Definition at line 27 of file AudioBufferSize.h.

getSamples()

size_t yarp::sig::AudioBufferSize::getSamples ( )

inline

Definition at line 28 of file AudioBufferSize.h.

read() [1/2]

bool yarp::sig::AudioBufferSize::read ( yarp::os::ConnectionReader &  reader )

inlineoverridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 35 of file AudioBufferSize.h.

read() [2/2]

bool yarp::sig::AudioBufferSize::read ( yarp::os::idl::WireReader &  reader )

inlineoverridevirtual

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

Definition at line 33 of file AudioBufferSize.h.

write() [1/2]

bool yarp::sig::AudioBufferSize::write ( const yarp::os::idl::WireWriter &  writer ) const

inlineoverridevirtual

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

Definition at line 34 of file AudioBufferSize.h.

write() [2/2]

bool yarp::sig::AudioBufferSize::write ( yarp::os::ConnectionWriter &  writer ) const

inlineoverridevirtual

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

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 36 of file AudioBufferSize.h.

---

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

• src/libYARP_sig/src/yarp/sig/AudioBufferSize.h
• src/libYARP_sig/src/yarp/sig/AudioBufferSize.cpp