SensorMetadata::Editor Class Reference

#include <multipleAnalogSensorsMsgs/idl_generated_code/SensorMetadata.h>

Inheritance diagram for SensorMetadata::Editor:

Public Member Functions
	Editor ()
	Editor (SensorMetadata &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 (SensorMetadata &obj, bool dirty=true)
bool	isValid () const
SensorMetadata &	state ()
void	start_editing ()
void	begin ()
void	stop_editing ()
void	end ()
void	set_name (const std::string &name)
const std::string &	get_name () const
virtual bool	will_set_name ()
virtual bool	did_set_name ()
void	set_frameName (const std::string &frameName)
const std::string &	get_frameName () const
virtual bool	will_set_frameName ()
virtual bool	did_set_frameName ()
void	set_additionalMetadata (const std::string &additionalMetadata)
const std::string &	get_additionalMetadata () const
virtual bool	will_set_additionalMetadata ()
virtual bool	did_set_additionalMetadata ()
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 55 of file SensorMetadata.h.

Constructor & Destructor Documentation

Editor() [1/4]

SensorMetadata::Editor::Editor

(

)

Definition at line 95 of file SensorMetadata.cpp.

Editor() [2/4]

SensorMetadata::Editor::Editor

(

SensorMetadata &

obj

)

Definition at line 105 of file SensorMetadata.cpp.

~Editor()

SensorMetadata::Editor::~Editor ( )

override

Definition at line 114 of file SensorMetadata.cpp.

Editor() [3/4]

SensorMetadata::Editor::Editor ( const Editor &  rhs )

delete

Editor() [4/4]

SensorMetadata::Editor::Editor ( Editor &&  rhs )

delete

Member Function Documentation

begin()

void SensorMetadata::Editor::begin ( )

inline

Definition at line 89 of file SensorMetadata.h.

clean()

void SensorMetadata::Editor::clean

(

)

Definition at line 244 of file SensorMetadata.cpp.

did_set_additionalMetadata()

bool SensorMetadata::Editor::did_set_additionalMetadata ( )

virtual

Definition at line 238 of file SensorMetadata.cpp.

did_set_frameName()

bool SensorMetadata::Editor::did_set_frameName ( )

virtual

Definition at line 210 of file SensorMetadata.cpp.

did_set_name()

bool SensorMetadata::Editor::did_set_name ( )

virtual

Definition at line 182 of file SensorMetadata.cpp.

edit()

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

Definition at line 122 of file SensorMetadata.cpp.

end()

void SensorMetadata::Editor::end ( )

inline

Definition at line 100 of file SensorMetadata.h.

get_additionalMetadata()

const std::string & SensorMetadata::Editor::get_additionalMetadata

(

)

const

Definition at line 226 of file SensorMetadata.cpp.

get_frameName()

const std::string & SensorMetadata::Editor::get_frameName

(

)

const

Definition at line 198 of file SensorMetadata.cpp.

get_name()

const std::string & SensorMetadata::Editor::get_name

(

)

const

Definition at line 170 of file SensorMetadata.cpp.

isValid()

bool SensorMetadata::Editor::isValid

(

)

const

Definition at line 134 of file SensorMetadata.cpp.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

read()

bool SensorMetadata::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 SensorMetadata.cpp.

set_additionalMetadata()

void SensorMetadata::Editor::set_additionalMetadata

(

const std::string &

additionalMetadata

)

Definition at line 216 of file SensorMetadata.cpp.

set_frameName()

void SensorMetadata::Editor::set_frameName

(

const std::string &

frameName

)

Definition at line 188 of file SensorMetadata.cpp.

set_name()

void SensorMetadata::Editor::set_name

(

const std::string &

name

)

Definition at line 160 of file SensorMetadata.cpp.

start_editing()

void SensorMetadata::Editor::start_editing

(

)

Definition at line 146 of file SensorMetadata.cpp.

state()

SensorMetadata & SensorMetadata::Editor::state

(

)

Definition at line 140 of file SensorMetadata.cpp.

stop_editing()

void SensorMetadata::Editor::stop_editing

(

)

Definition at line 152 of file SensorMetadata.cpp.

will_set_additionalMetadata()

bool SensorMetadata::Editor::will_set_additionalMetadata ( )

virtual

Definition at line 232 of file SensorMetadata.cpp.

will_set_frameName()

bool SensorMetadata::Editor::will_set_frameName ( )

virtual

Definition at line 204 of file SensorMetadata.cpp.

will_set_name()

bool SensorMetadata::Editor::will_set_name ( )

virtual

Definition at line 176 of file SensorMetadata.cpp.

write()

bool SensorMetadata::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 383 of file SensorMetadata.cpp.

---

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

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