yarp::dev::audioBufferSizeData::Editor Class Reference

#include <yarp/dev/audioBufferSizeData.h>

Inheritance diagram for yarp::dev::audioBufferSizeData::Editor:

Public Member Functions
	Editor ()
	Editor (audioBufferSizeData &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 (audioBufferSizeData &obj, bool dirty=true)
bool	isValid () const
audioBufferSizeData &	state ()
void	start_editing ()
void	begin ()
void	stop_editing ()
void	end ()
void	set_m_samples (const std::int32_t m_samples)
std::int32_t	get_m_samples () const
virtual bool	will_set_m_samples ()
virtual bool	did_set_m_samples ()
void	set_m_channels (const std::int32_t m_channels)
std::int32_t	get_m_channels () const
virtual bool	will_set_m_channels ()
virtual bool	did_set_m_channels ()
void	set_m_depth (const std::int32_t m_depth)
std::int32_t	get_m_depth () const
virtual bool	will_set_m_depth ()
virtual bool	did_set_m_depth ()
void	set_size (const std::int32_t size)
std::int32_t	get_size () const
virtual bool	will_set_size ()
virtual bool	did_set_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 59 of file audioBufferSizeData.h.

Constructor & Destructor Documentation

Editor() [1/4]

yarp::dev::audioBufferSizeData::Editor::Editor

(

)

Definition at line 104 of file audioBufferSizeData.cpp.

Editor() [2/4]

yarp::dev::audioBufferSizeData::Editor::Editor

(

audioBufferSizeData &

obj

)

Definition at line 114 of file audioBufferSizeData.cpp.

~Editor()

yarp::dev::audioBufferSizeData::Editor::~Editor ( )

override

Definition at line 123 of file audioBufferSizeData.cpp.

Editor() [3/4]

yarp::dev::audioBufferSizeData::Editor::Editor ( const Editor &  rhs )

delete

Editor() [4/4]

yarp::dev::audioBufferSizeData::Editor::Editor ( Editor &&  rhs )

delete

Member Function Documentation

begin()

void yarp::dev::audioBufferSizeData::Editor::begin ( )

inline

Definition at line 93 of file audioBufferSizeData.h.

clean()

void yarp::dev::audioBufferSizeData::Editor::clean

(

)

Definition at line 281 of file audioBufferSizeData.cpp.

did_set_m_channels()

bool yarp::dev::audioBufferSizeData::Editor::did_set_m_channels ( )

virtual

Definition at line 219 of file audioBufferSizeData.cpp.

did_set_m_depth()

bool yarp::dev::audioBufferSizeData::Editor::did_set_m_depth ( )

virtual

Definition at line 247 of file audioBufferSizeData.cpp.

did_set_m_samples()

bool yarp::dev::audioBufferSizeData::Editor::did_set_m_samples ( )

virtual

Definition at line 191 of file audioBufferSizeData.cpp.

did_set_size()

bool yarp::dev::audioBufferSizeData::Editor::did_set_size ( )

virtual

Definition at line 275 of file audioBufferSizeData.cpp.

edit()

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

Definition at line 131 of file audioBufferSizeData.cpp.

end()

void yarp::dev::audioBufferSizeData::Editor::end ( )

inline

Definition at line 104 of file audioBufferSizeData.h.

get_m_channels()

std::int32_t yarp::dev::audioBufferSizeData::Editor::get_m_channels

(

)

const

Definition at line 207 of file audioBufferSizeData.cpp.

get_m_depth()

std::int32_t yarp::dev::audioBufferSizeData::Editor::get_m_depth

(

)

const

Definition at line 235 of file audioBufferSizeData.cpp.

get_m_samples()

std::int32_t yarp::dev::audioBufferSizeData::Editor::get_m_samples

(

)

const

Definition at line 179 of file audioBufferSizeData.cpp.

get_size()

std::int32_t yarp::dev::audioBufferSizeData::Editor::get_size

(

)

const

Definition at line 263 of file audioBufferSizeData.cpp.

isValid()

bool yarp::dev::audioBufferSizeData::Editor::isValid

(

)

const

Definition at line 143 of file audioBufferSizeData.cpp.

operator=() [1/2]

Editor& yarp::dev::audioBufferSizeData::Editor::operator= ( const Editor &  rhs )

delete

operator=() [2/2]

Editor& yarp::dev::audioBufferSizeData::Editor::operator= ( Editor &&  rhs )

delete

read()

bool yarp::dev::audioBufferSizeData::Editor::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

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::PortReader.

Definition at line 287 of file audioBufferSizeData.cpp.

set_m_channels()

void yarp::dev::audioBufferSizeData::Editor::set_m_channels

(

const std::int32_t

m_channels

)

Definition at line 197 of file audioBufferSizeData.cpp.

set_m_depth()

void yarp::dev::audioBufferSizeData::Editor::set_m_depth

(

const std::int32_t

m_depth

)

Definition at line 225 of file audioBufferSizeData.cpp.

set_m_samples()

void yarp::dev::audioBufferSizeData::Editor::set_m_samples

(

const std::int32_t

m_samples

)

Definition at line 169 of file audioBufferSizeData.cpp.

set_size()

void yarp::dev::audioBufferSizeData::Editor::set_size

(

const std::int32_t

size

)

Definition at line 253 of file audioBufferSizeData.cpp.

start_editing()

void yarp::dev::audioBufferSizeData::Editor::start_editing

(

)

Definition at line 155 of file audioBufferSizeData.cpp.

state()

audioBufferSizeData & yarp::dev::audioBufferSizeData::Editor::state

(

)

Definition at line 149 of file audioBufferSizeData.cpp.

stop_editing()

void yarp::dev::audioBufferSizeData::Editor::stop_editing

(

)

Definition at line 161 of file audioBufferSizeData.cpp.

will_set_m_channels()

bool yarp::dev::audioBufferSizeData::Editor::will_set_m_channels ( )

virtual

Definition at line 213 of file audioBufferSizeData.cpp.

will_set_m_depth()

bool yarp::dev::audioBufferSizeData::Editor::will_set_m_depth ( )

virtual

Definition at line 241 of file audioBufferSizeData.cpp.

will_set_m_samples()

bool yarp::dev::audioBufferSizeData::Editor::will_set_m_samples ( )

virtual

Definition at line 185 of file audioBufferSizeData.cpp.

will_set_size()

bool yarp::dev::audioBufferSizeData::Editor::will_set_size ( )

virtual

Definition at line 269 of file audioBufferSizeData.cpp.

write()

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

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::PortWriter.

Definition at line 435 of file audioBufferSizeData.cpp.

---

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

• src/libYARP_dev/src/idl_generated_code/yarp/dev/audioBufferSizeData.h
• src/libYARP_dev/src/idl_generated_code/yarp/dev/audioBufferSizeData.cpp