SensorMeasurements::Editor Class Reference

#include <multipleAnalogSensorsMsgs/idl_generated_code/SensorMeasurements.h>

Inheritance diagram for SensorMeasurements::Editor:

Public Member Functions
	Editor ()
	Editor (SensorMeasurements &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 (SensorMeasurements &obj, bool dirty=true)
bool	isValid () const
SensorMeasurements &	state ()
void	start_editing ()
void	begin ()
void	stop_editing ()
void	end ()
void	set_measurements (const std::vector< SensorMeasurement > &measurements)
void	set_measurements (size_t index, const SensorMeasurement &elem)
const std::vector< SensorMeasurement > &	get_measurements () const
virtual bool	will_set_measurements ()
virtual bool	did_set_measurements ()
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...
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 52 of file SensorMeasurements.h.

Constructor & Destructor Documentation

Editor() [1/4]

SensorMeasurements::Editor::Editor

(

)

Definition at line 77 of file SensorMeasurements.cpp.

Editor() [2/4]

SensorMeasurements::Editor::Editor

(

SensorMeasurements &

obj

)

Definition at line 87 of file SensorMeasurements.cpp.

~Editor()

SensorMeasurements::Editor::~Editor ( )

override

Definition at line 96 of file SensorMeasurements.cpp.

Editor() [3/4]

SensorMeasurements::Editor::Editor ( const Editor &  rhs )

delete

Editor() [4/4]

SensorMeasurements::Editor::Editor ( Editor &&  rhs )

delete

Member Function Documentation

begin()

void SensorMeasurements::Editor::begin ( )

inline

Definition at line 86 of file SensorMeasurements.h.

clean()

void SensorMeasurements::Editor::clean

(

)

Definition at line 180 of file SensorMeasurements.cpp.

did_set_measurements()

bool SensorMeasurements::Editor::did_set_measurements ( )

virtual

Definition at line 174 of file SensorMeasurements.cpp.

edit()

bool SensorMeasurements::Editor::edit	(	SensorMeasurements &	obj,
		bool	dirty = true
	)

Definition at line 104 of file SensorMeasurements.cpp.

end()

void SensorMeasurements::Editor::end ( )

inline

Definition at line 97 of file SensorMeasurements.h.

get_measurements()

const std::vector< SensorMeasurement > & SensorMeasurements::Editor::get_measurements

(

)

const

Definition at line 162 of file SensorMeasurements.cpp.

isValid()

bool SensorMeasurements::Editor::isValid

(

)

const

Definition at line 116 of file SensorMeasurements.cpp.

operator=() [1/2]

Editor& SensorMeasurements::Editor::operator= ( const Editor &  rhs )

delete

operator=() [2/2]

Editor& SensorMeasurements::Editor::operator= ( Editor &&  rhs )

delete

read()

bool SensorMeasurements::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 186 of file SensorMeasurements.cpp.

set_measurements() [1/2]

void SensorMeasurements::Editor::set_measurements

(

const std::vector< SensorMeasurement > &

measurements

)

Definition at line 142 of file SensorMeasurements.cpp.

set_measurements() [2/2]

void SensorMeasurements::Editor::set_measurements	(	size_t	index,
		const SensorMeasurement &	elem
	)

Definition at line 152 of file SensorMeasurements.cpp.

start_editing()

void SensorMeasurements::Editor::start_editing

(

)

Definition at line 128 of file SensorMeasurements.cpp.

state()

SensorMeasurements & SensorMeasurements::Editor::state

(

)

Definition at line 122 of file SensorMeasurements.cpp.

stop_editing()

void SensorMeasurements::Editor::stop_editing

(

)

Definition at line 134 of file SensorMeasurements.cpp.

will_set_measurements()

bool SensorMeasurements::Editor::will_set_measurements ( )

virtual

Definition at line 168 of file SensorMeasurements.cpp.

write()

bool SensorMeasurements::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 289 of file SensorMeasurements.cpp.

---

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

• src/devices/multipleAnalogSensorsMsgs/idl_generated_code/SensorMeasurements.h
• src/devices/multipleAnalogSensorsMsgs/idl_generated_code/SensorMeasurements.cpp