YARP
Yet Another Robot Platform
Public Member Functions | List of all members
yarp::dev::AudioPlayerStatus::Editor Class Reference

#include <yarp/dev/AudioPlayerStatus.h>

+ Inheritance diagram for yarp::dev::AudioPlayerStatus::Editor:

Public Member Functions

 Editor ()
 
 Editor (AudioPlayerStatus &obj)
 
 ~Editor () override
 
 Editor (const Editor &rhs)=delete
 
 Editor (Editor &&rhs)=delete
 
Editor & operator= (const Editor &rhs)=delete
 
Editor & operator= (Editor &&rhs)=delete
 
bool edit (AudioPlayerStatus &obj, bool dirty=true)
 
bool isValid () const
 
AudioPlayerStatus & state ()
 
void start_editing ()
 
void begin ()
 
void stop_editing ()
 
void end ()
 
void set_enabled (const bool enabled)
 
bool get_enabled () const
 
virtual bool will_set_enabled ()
 
virtual bool did_set_enabled ()
 
void set_current_buffer_size (const size_t current_buffer_size)
 
size_t get_current_buffer_size () const
 
virtual bool will_set_current_buffer_size ()
 
virtual bool did_set_current_buffer_size ()
 
void set_max_buffer_size (const size_t max_buffer_size)
 
size_t get_max_buffer_size () const
 
virtual bool will_set_max_buffer_size ()
 
virtual bool did_set_max_buffer_size ()
 
void clean ()
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection. More...
 
- Public Member Functions inherited from yarp::os::Wire
yarp::os::WireLink & yarp ()
 Get YARP state associated with this object. More...
 
const yarp::os::WireLink & yarp () const
 Get YARP state associated with this object (const version). More...
 
- 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
 

Detailed Description

Definition at line 72 of file AudioPlayerStatus.h.

Constructor & Destructor Documentation

◆ Editor() [1/4]

yarp::dev::AudioPlayerStatus::Editor::Editor ( )

Definition at line 95 of file AudioPlayerStatus.cpp.

◆ Editor() [2/4]

yarp::dev::AudioPlayerStatus::Editor::Editor ( AudioPlayerStatus &  obj)

Definition at line 105 of file AudioPlayerStatus.cpp.

◆ ~Editor()

yarp::dev::AudioPlayerStatus::Editor::~Editor ( )
override

Definition at line 114 of file AudioPlayerStatus.cpp.

◆ Editor() [3/4]

yarp::dev::AudioPlayerStatus::Editor::Editor ( const Editor &  rhs)
delete

◆ Editor() [4/4]

yarp::dev::AudioPlayerStatus::Editor::Editor ( Editor &&  rhs)
delete

Member Function Documentation

◆ begin()

void yarp::dev::AudioPlayerStatus::Editor::begin ( )
inline

Definition at line 106 of file AudioPlayerStatus.h.

◆ clean()

void yarp::dev::AudioPlayerStatus::Editor::clean ( )

Definition at line 244 of file AudioPlayerStatus.cpp.

◆ did_set_current_buffer_size()

bool yarp::dev::AudioPlayerStatus::Editor::did_set_current_buffer_size ( )
virtual

Definition at line 210 of file AudioPlayerStatus.cpp.

◆ did_set_enabled()

bool yarp::dev::AudioPlayerStatus::Editor::did_set_enabled ( )
virtual

Definition at line 182 of file AudioPlayerStatus.cpp.

◆ did_set_max_buffer_size()

bool yarp::dev::AudioPlayerStatus::Editor::did_set_max_buffer_size ( )
virtual

Definition at line 238 of file AudioPlayerStatus.cpp.

◆ edit()

bool yarp::dev::AudioPlayerStatus::Editor::edit ( AudioPlayerStatus &  obj,
bool  dirty = true 
)

Definition at line 122 of file AudioPlayerStatus.cpp.

◆ end()

void yarp::dev::AudioPlayerStatus::Editor::end ( )
inline

Definition at line 117 of file AudioPlayerStatus.h.

◆ get_current_buffer_size()

size_t yarp::dev::AudioPlayerStatus::Editor::get_current_buffer_size ( ) const

Definition at line 198 of file AudioPlayerStatus.cpp.

◆ get_enabled()

bool yarp::dev::AudioPlayerStatus::Editor::get_enabled ( ) const

Definition at line 170 of file AudioPlayerStatus.cpp.

◆ get_max_buffer_size()

size_t yarp::dev::AudioPlayerStatus::Editor::get_max_buffer_size ( ) const

Definition at line 226 of file AudioPlayerStatus.cpp.

◆ isValid()

bool yarp::dev::AudioPlayerStatus::Editor::isValid ( ) const

Definition at line 134 of file AudioPlayerStatus.cpp.

◆ operator=() [1/2]

Editor& yarp::dev::AudioPlayerStatus::Editor::operator= ( const Editor &  rhs)
delete

◆ operator=() [2/2]

Editor& yarp::dev::AudioPlayerStatus::Editor::operator= ( Editor &&  rhs)
delete

◆ read()

bool yarp::dev::AudioPlayerStatus::Editor::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::PortReader.

Definition at line 250 of file AudioPlayerStatus.cpp.

◆ set_current_buffer_size()

void yarp::dev::AudioPlayerStatus::Editor::set_current_buffer_size ( const size_t  current_buffer_size)

Definition at line 188 of file AudioPlayerStatus.cpp.

◆ set_enabled()

void yarp::dev::AudioPlayerStatus::Editor::set_enabled ( const bool  enabled)

Definition at line 160 of file AudioPlayerStatus.cpp.

◆ set_max_buffer_size()

void yarp::dev::AudioPlayerStatus::Editor::set_max_buffer_size ( const size_t  max_buffer_size)

Definition at line 216 of file AudioPlayerStatus.cpp.

◆ start_editing()

void yarp::dev::AudioPlayerStatus::Editor::start_editing ( )

Definition at line 146 of file AudioPlayerStatus.cpp.

◆ state()

AudioPlayerStatus & yarp::dev::AudioPlayerStatus::Editor::state ( )

Definition at line 140 of file AudioPlayerStatus.cpp.

◆ stop_editing()

void yarp::dev::AudioPlayerStatus::Editor::stop_editing ( )

Definition at line 152 of file AudioPlayerStatus.cpp.

◆ will_set_current_buffer_size()

bool yarp::dev::AudioPlayerStatus::Editor::will_set_current_buffer_size ( )
virtual

Definition at line 204 of file AudioPlayerStatus.cpp.

◆ will_set_enabled()

bool yarp::dev::AudioPlayerStatus::Editor::will_set_enabled ( )
virtual

Definition at line 176 of file AudioPlayerStatus.cpp.

◆ will_set_max_buffer_size()

bool yarp::dev::AudioPlayerStatus::Editor::will_set_max_buffer_size ( )
virtual

Definition at line 232 of file AudioPlayerStatus.cpp.

◆ write()

bool yarp::dev::AudioPlayerStatus::Editor::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::PortWriter.

Definition at line 392 of file AudioPlayerStatus.cpp.

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