yarp::dev::MobileBaseVelocity::Editor Class Reference

#include <yarp/dev/MobileBaseVelocity.h>

Inheritance diagram for yarp::dev::MobileBaseVelocity::Editor:

Public Member Functions
	Editor ()
	Editor (MobileBaseVelocity &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 (MobileBaseVelocity &obj, bool dirty=true)
bool	isValid () const
MobileBaseVelocity &	state ()
void	start_editing ()
void	begin ()
void	stop_editing ()
void	end ()
void	set_vel_x (const double vel_x)
double	get_vel_x () const
virtual bool	will_set_vel_x ()
virtual bool	did_set_vel_x ()
void	set_vel_y (const double vel_y)
double	get_vel_y () const
virtual bool	will_set_vel_y ()
virtual bool	did_set_vel_y ()
void	set_vel_theta (const double vel_theta)
double	get_vel_theta () const
virtual bool	will_set_vel_theta ()
virtual bool	did_set_vel_theta ()
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 66 of file MobileBaseVelocity.h.

Constructor & Destructor Documentation

Editor() [1/4]

yarp::dev::MobileBaseVelocity::Editor::Editor

(

)

Definition at line 95 of file MobileBaseVelocity.cpp.

Editor() [2/4]

yarp::dev::MobileBaseVelocity::Editor::Editor

(

MobileBaseVelocity &

obj

)

Definition at line 105 of file MobileBaseVelocity.cpp.

~Editor()

yarp::dev::MobileBaseVelocity::Editor::~Editor ( )

override

Definition at line 114 of file MobileBaseVelocity.cpp.

Editor() [3/4]

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

delete

Editor() [4/4]

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

delete

Member Function Documentation

begin()

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

inline

Definition at line 100 of file MobileBaseVelocity.h.

clean()

void yarp::dev::MobileBaseVelocity::Editor::clean

(

)

Definition at line 244 of file MobileBaseVelocity.cpp.

did_set_vel_theta()

bool yarp::dev::MobileBaseVelocity::Editor::did_set_vel_theta ( )

virtual

Definition at line 238 of file MobileBaseVelocity.cpp.

did_set_vel_x()

bool yarp::dev::MobileBaseVelocity::Editor::did_set_vel_x ( )

virtual

Definition at line 182 of file MobileBaseVelocity.cpp.

did_set_vel_y()

bool yarp::dev::MobileBaseVelocity::Editor::did_set_vel_y ( )

virtual

Definition at line 210 of file MobileBaseVelocity.cpp.

edit()

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

Definition at line 122 of file MobileBaseVelocity.cpp.

end()

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

inline

Definition at line 111 of file MobileBaseVelocity.h.

get_vel_theta()

double yarp::dev::MobileBaseVelocity::Editor::get_vel_theta

(

)

const

Definition at line 226 of file MobileBaseVelocity.cpp.

get_vel_x()

double yarp::dev::MobileBaseVelocity::Editor::get_vel_x

(

)

const

Definition at line 170 of file MobileBaseVelocity.cpp.

get_vel_y()

double yarp::dev::MobileBaseVelocity::Editor::get_vel_y

(

)

const

Definition at line 198 of file MobileBaseVelocity.cpp.

isValid()

bool yarp::dev::MobileBaseVelocity::Editor::isValid

(

)

const

Definition at line 134 of file MobileBaseVelocity.cpp.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

read()

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

set_vel_theta()

void yarp::dev::MobileBaseVelocity::Editor::set_vel_theta

(

const double

vel_theta

)

Definition at line 216 of file MobileBaseVelocity.cpp.

set_vel_x()

void yarp::dev::MobileBaseVelocity::Editor::set_vel_x

(

const double

vel_x

)

Definition at line 160 of file MobileBaseVelocity.cpp.

set_vel_y()

void yarp::dev::MobileBaseVelocity::Editor::set_vel_y

(

const double

vel_y

)

Definition at line 188 of file MobileBaseVelocity.cpp.

start_editing()

void yarp::dev::MobileBaseVelocity::Editor::start_editing

(

)

Definition at line 146 of file MobileBaseVelocity.cpp.

state()

MobileBaseVelocity & yarp::dev::MobileBaseVelocity::Editor::state

(

)

Definition at line 140 of file MobileBaseVelocity.cpp.

stop_editing()

void yarp::dev::MobileBaseVelocity::Editor::stop_editing

(

)

Definition at line 152 of file MobileBaseVelocity.cpp.

will_set_vel_theta()

bool yarp::dev::MobileBaseVelocity::Editor::will_set_vel_theta ( )

virtual

Definition at line 232 of file MobileBaseVelocity.cpp.

will_set_vel_x()

bool yarp::dev::MobileBaseVelocity::Editor::will_set_vel_x ( )

virtual

Definition at line 176 of file MobileBaseVelocity.cpp.

will_set_vel_y()

bool yarp::dev::MobileBaseVelocity::Editor::will_set_vel_y ( )

virtual

Definition at line 204 of file MobileBaseVelocity.cpp.

write()

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

---

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

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