SensorMeasurement::Editor Class Reference

#include <multipleAnalogSensorsMsgs/idl_generated_code/SensorMeasurement.h>

Inheritance diagram for SensorMeasurement::Editor:

Public Member Functions
	Editor ()
	Editor (SensorMeasurement &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 (SensorMeasurement &obj, bool dirty=true)
bool	isValid () const
SensorMeasurement &	state ()
void	start_editing ()
void	begin ()
void	stop_editing ()
void	end ()
void	set_measurement (const yarp::sig::Vector &measurement)
const yarp::sig::Vector &	get_measurement () const
virtual bool	will_set_measurement ()
virtual bool	did_set_measurement ()
void	set_timestamp (const double timestamp)
double	get_timestamp () const
virtual bool	will_set_timestamp ()
virtual bool	did_set_timestamp ()
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 54 of file SensorMeasurement.h.

Constructor & Destructor Documentation

Editor() [1/4]

SensorMeasurement::Editor::Editor

(

)

Definition at line 86 of file SensorMeasurement.cpp.

Editor() [2/4]

SensorMeasurement::Editor::Editor

(

SensorMeasurement &

obj

)

Definition at line 96 of file SensorMeasurement.cpp.

~Editor()

SensorMeasurement::Editor::~Editor ( )

override

Definition at line 105 of file SensorMeasurement.cpp.

Editor() [3/4]

SensorMeasurement::Editor::Editor ( const Editor &  rhs )

delete

Editor() [4/4]

SensorMeasurement::Editor::Editor ( Editor &&  rhs )

delete

Member Function Documentation

begin()

void SensorMeasurement::Editor::begin ( )

inline

Definition at line 88 of file SensorMeasurement.h.

clean()

void SensorMeasurement::Editor::clean

(

)

Definition at line 207 of file SensorMeasurement.cpp.

did_set_measurement()

bool SensorMeasurement::Editor::did_set_measurement ( )

virtual

Definition at line 173 of file SensorMeasurement.cpp.

did_set_timestamp()

bool SensorMeasurement::Editor::did_set_timestamp ( )

virtual

Definition at line 201 of file SensorMeasurement.cpp.

edit()

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

Definition at line 113 of file SensorMeasurement.cpp.

end()

void SensorMeasurement::Editor::end ( )

inline

Definition at line 99 of file SensorMeasurement.h.

get_measurement()

const yarp::sig::Vector & SensorMeasurement::Editor::get_measurement

(

)

const

Definition at line 161 of file SensorMeasurement.cpp.

get_timestamp()

double SensorMeasurement::Editor::get_timestamp

(

)

const

Definition at line 189 of file SensorMeasurement.cpp.

isValid()

bool SensorMeasurement::Editor::isValid

(

)

const

Definition at line 125 of file SensorMeasurement.cpp.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

read()

bool SensorMeasurement::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 213 of file SensorMeasurement.cpp.

set_measurement()

void SensorMeasurement::Editor::set_measurement

(

const yarp::sig::Vector &

measurement

)

Definition at line 151 of file SensorMeasurement.cpp.

set_timestamp()

void SensorMeasurement::Editor::set_timestamp

(

const double

timestamp

)

Definition at line 179 of file SensorMeasurement.cpp.

start_editing()

void SensorMeasurement::Editor::start_editing

(

)

Definition at line 137 of file SensorMeasurement.cpp.

state()

SensorMeasurement & SensorMeasurement::Editor::state

(

)

Definition at line 131 of file SensorMeasurement.cpp.

stop_editing()

void SensorMeasurement::Editor::stop_editing

(

)

Definition at line 143 of file SensorMeasurement.cpp.

will_set_measurement()

bool SensorMeasurement::Editor::will_set_measurement ( )

virtual

Definition at line 167 of file SensorMeasurement.cpp.

will_set_timestamp()

bool SensorMeasurement::Editor::will_set_timestamp ( )

virtual

Definition at line 195 of file SensorMeasurement.cpp.

write()

bool SensorMeasurement::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 331 of file SensorMeasurement.cpp.

---

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

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