yarp::dev::LaserScan2D::Editor Class Reference

#include <yarp/dev/LaserScan2D.h>

Inheritance diagram for yarp::dev::LaserScan2D::Editor:

Public Member Functions
	Editor ()
	Editor (LaserScan2D &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 (LaserScan2D &obj, bool dirty=true)
bool	isValid () const
LaserScan2D &	state ()
void	start_editing ()
void	begin ()
void	stop_editing ()
void	end ()
void	set_angle_min (const double angle_min)
double	get_angle_min () const
virtual bool	will_set_angle_min ()
virtual bool	did_set_angle_min ()
void	set_angle_max (const double angle_max)
double	get_angle_max () const
virtual bool	will_set_angle_max ()
virtual bool	did_set_angle_max ()
void	set_range_min (const double range_min)
double	get_range_min () const
virtual bool	will_set_range_min ()
virtual bool	did_set_range_min ()
void	set_range_max (const double range_max)
double	get_range_max () const
virtual bool	will_set_range_max ()
virtual bool	did_set_range_max ()
void	set_scans (const yarp::sig::Vector &scans)
const yarp::sig::Vector &	get_scans () const
virtual bool	will_set_scans ()
virtual bool	did_set_scans ()
void	set_status (const std::int32_t status)
std::int32_t	get_status () const
virtual bool	will_set_status ()
virtual bool	did_set_status ()
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 79 of file LaserScan2D.h.

Constructor & Destructor Documentation

Editor() [1/4]

yarp::dev::LaserScan2D::Editor::Editor

(

)

Definition at line 122 of file LaserScan2D.cpp.

Editor() [2/4]

yarp::dev::LaserScan2D::Editor::Editor

(

LaserScan2D &

obj

)

Definition at line 132 of file LaserScan2D.cpp.

~Editor()

yarp::dev::LaserScan2D::Editor::~Editor ( )

override

Definition at line 141 of file LaserScan2D.cpp.

Editor() [3/4]

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

delete

Editor() [4/4]

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

delete

Member Function Documentation

begin()

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

inline

Definition at line 113 of file LaserScan2D.h.

clean()

void yarp::dev::LaserScan2D::Editor::clean

(

)

Definition at line 355 of file LaserScan2D.cpp.

did_set_angle_max()

bool yarp::dev::LaserScan2D::Editor::did_set_angle_max ( )

virtual

Definition at line 237 of file LaserScan2D.cpp.

did_set_angle_min()

bool yarp::dev::LaserScan2D::Editor::did_set_angle_min ( )

virtual

Definition at line 209 of file LaserScan2D.cpp.

did_set_range_max()

bool yarp::dev::LaserScan2D::Editor::did_set_range_max ( )

virtual

Definition at line 293 of file LaserScan2D.cpp.

did_set_range_min()

bool yarp::dev::LaserScan2D::Editor::did_set_range_min ( )

virtual

Definition at line 265 of file LaserScan2D.cpp.

did_set_scans()

bool yarp::dev::LaserScan2D::Editor::did_set_scans ( )

virtual

Definition at line 321 of file LaserScan2D.cpp.

did_set_status()

bool yarp::dev::LaserScan2D::Editor::did_set_status ( )

virtual

Definition at line 349 of file LaserScan2D.cpp.

edit()

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

Definition at line 149 of file LaserScan2D.cpp.

end()

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

inline

Definition at line 124 of file LaserScan2D.h.

get_angle_max()

double yarp::dev::LaserScan2D::Editor::get_angle_max

(

)

const

Definition at line 225 of file LaserScan2D.cpp.

get_angle_min()

double yarp::dev::LaserScan2D::Editor::get_angle_min

(

)

const

Definition at line 197 of file LaserScan2D.cpp.

get_range_max()

double yarp::dev::LaserScan2D::Editor::get_range_max

(

)

const

Definition at line 281 of file LaserScan2D.cpp.

get_range_min()

double yarp::dev::LaserScan2D::Editor::get_range_min

(

)

const

Definition at line 253 of file LaserScan2D.cpp.

get_scans()

const yarp::sig::Vector & yarp::dev::LaserScan2D::Editor::get_scans

(

)

const

Definition at line 309 of file LaserScan2D.cpp.

get_status()

std::int32_t yarp::dev::LaserScan2D::Editor::get_status

(

)

const

Definition at line 337 of file LaserScan2D.cpp.

isValid()

bool yarp::dev::LaserScan2D::Editor::isValid

(

)

const

Definition at line 161 of file LaserScan2D.cpp.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

read()

bool yarp::dev::LaserScan2D::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 361 of file LaserScan2D.cpp.

set_angle_max()

void yarp::dev::LaserScan2D::Editor::set_angle_max

(

const double

angle_max

)

Definition at line 215 of file LaserScan2D.cpp.

set_angle_min()

void yarp::dev::LaserScan2D::Editor::set_angle_min

(

const double

angle_min

)

Definition at line 187 of file LaserScan2D.cpp.

set_range_max()

void yarp::dev::LaserScan2D::Editor::set_range_max

(

const double

range_max

)

Definition at line 271 of file LaserScan2D.cpp.

set_range_min()

void yarp::dev::LaserScan2D::Editor::set_range_min

(

const double

range_min

)

Definition at line 243 of file LaserScan2D.cpp.

set_scans()

void yarp::dev::LaserScan2D::Editor::set_scans

(

const yarp::sig::Vector &

scans

)

Definition at line 299 of file LaserScan2D.cpp.

set_status()

void yarp::dev::LaserScan2D::Editor::set_status

(

const std::int32_t

status

)

Definition at line 327 of file LaserScan2D.cpp.

start_editing()

void yarp::dev::LaserScan2D::Editor::start_editing

(

)

Definition at line 173 of file LaserScan2D.cpp.

state()

LaserScan2D & yarp::dev::LaserScan2D::Editor::state

(

)

Definition at line 167 of file LaserScan2D.cpp.

stop_editing()

void yarp::dev::LaserScan2D::Editor::stop_editing

(

)

Definition at line 179 of file LaserScan2D.cpp.

will_set_angle_max()

bool yarp::dev::LaserScan2D::Editor::will_set_angle_max ( )

virtual

Definition at line 231 of file LaserScan2D.cpp.

will_set_angle_min()

bool yarp::dev::LaserScan2D::Editor::will_set_angle_min ( )

virtual

Definition at line 203 of file LaserScan2D.cpp.

will_set_range_max()

bool yarp::dev::LaserScan2D::Editor::will_set_range_max ( )

virtual

Definition at line 287 of file LaserScan2D.cpp.

will_set_range_min()

bool yarp::dev::LaserScan2D::Editor::will_set_range_min ( )

virtual

Definition at line 259 of file LaserScan2D.cpp.

will_set_scans()

bool yarp::dev::LaserScan2D::Editor::will_set_scans ( )

virtual

Definition at line 315 of file LaserScan2D.cpp.

will_set_status()

bool yarp::dev::LaserScan2D::Editor::will_set_status ( )

virtual

Definition at line 343 of file LaserScan2D.cpp.

write()

bool yarp::dev::LaserScan2D::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 554 of file LaserScan2D.cpp.

---

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

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