YARP
Yet Another Robot Platform
return_getAllTransforms::Editor Class Reference

#include <frameTransformStorageMsgs/idl_generated_code/return_getAllTransforms.h>

+ Inheritance diagram for return_getAllTransforms::Editor:

Public Member Functions

 Editor ()
 
 Editor (return_getAllTransforms &obj)
 
 ~Editor () override
 
 Editor (const Editor &rhs)=delete
 
 Editor (Editor &&rhs)=delete
 
Editoroperator= (const Editor &rhs)=delete
 
Editoroperator= (Editor &&rhs)=delete
 
bool edit (return_getAllTransforms &obj, bool dirty=true)
 
bool isValid () const
 
return_getAllTransformsstate ()
 
void start_editing ()
 
void begin ()
 
void stop_editing ()
 
void end ()
 
void set_retvalue (const bool retvalue)
 
bool get_retvalue () const
 
virtual bool will_set_retvalue ()
 
virtual bool did_set_retvalue ()
 
void set_transforms_list (const std::vector< yarp::math::FrameTransform > &transforms_list)
 
void set_transforms_list (size_t index, const yarp::math::FrameTransform &elem)
 
const std::vector< yarp::math::FrameTransform > & get_transforms_list () const
 
virtual bool will_set_transforms_list ()
 
virtual bool did_set_transforms_list ()
 
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::WireLinkyarp ()
 Get YARP state associated with this object. More...
 
const yarp::os::WireLinkyarp () 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 51 of file return_getAllTransforms.h.

Constructor & Destructor Documentation

◆ Editor() [1/4]

return_getAllTransforms::Editor::Editor ( )

Definition at line 83 of file return_getAllTransforms.cpp.

◆ Editor() [2/4]

return_getAllTransforms::Editor::Editor ( return_getAllTransforms obj)

Definition at line 93 of file return_getAllTransforms.cpp.

◆ ~Editor()

return_getAllTransforms::Editor::~Editor ( )
override

Definition at line 102 of file return_getAllTransforms.cpp.

◆ Editor() [3/4]

return_getAllTransforms::Editor::Editor ( const Editor rhs)
delete

◆ Editor() [4/4]

return_getAllTransforms::Editor::Editor ( Editor &&  rhs)
delete

Member Function Documentation

◆ begin()

void return_getAllTransforms::Editor::begin ( )
inline

Definition at line 85 of file return_getAllTransforms.h.

◆ clean()

void return_getAllTransforms::Editor::clean ( )

Definition at line 214 of file return_getAllTransforms.cpp.

◆ did_set_retvalue()

bool return_getAllTransforms::Editor::did_set_retvalue ( )
virtual

Definition at line 170 of file return_getAllTransforms.cpp.

◆ did_set_transforms_list()

bool return_getAllTransforms::Editor::did_set_transforms_list ( )
virtual

Definition at line 208 of file return_getAllTransforms.cpp.

◆ edit()

bool return_getAllTransforms::Editor::edit ( return_getAllTransforms obj,
bool  dirty = true 
)

Definition at line 110 of file return_getAllTransforms.cpp.

◆ end()

void return_getAllTransforms::Editor::end ( )
inline

Definition at line 96 of file return_getAllTransforms.h.

◆ get_retvalue()

bool return_getAllTransforms::Editor::get_retvalue ( ) const

Definition at line 158 of file return_getAllTransforms.cpp.

◆ get_transforms_list()

const std::vector< yarp::math::FrameTransform > & return_getAllTransforms::Editor::get_transforms_list ( ) const

Definition at line 196 of file return_getAllTransforms.cpp.

◆ isValid()

bool return_getAllTransforms::Editor::isValid ( ) const

Definition at line 122 of file return_getAllTransforms.cpp.

◆ operator=() [1/2]

Editor& return_getAllTransforms::Editor::operator= ( const Editor rhs)
delete

◆ operator=() [2/2]

Editor& return_getAllTransforms::Editor::operator= ( Editor &&  rhs)
delete

◆ read()

bool return_getAllTransforms::Editor::read ( yarp::os::ConnectionReader reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 220 of file return_getAllTransforms.cpp.

◆ set_retvalue()

void return_getAllTransforms::Editor::set_retvalue ( const bool  retvalue)

Definition at line 148 of file return_getAllTransforms.cpp.

◆ set_transforms_list() [1/2]

void return_getAllTransforms::Editor::set_transforms_list ( const std::vector< yarp::math::FrameTransform > &  transforms_list)

Definition at line 176 of file return_getAllTransforms.cpp.

◆ set_transforms_list() [2/2]

void return_getAllTransforms::Editor::set_transforms_list ( size_t  index,
const yarp::math::FrameTransform elem 
)

Definition at line 186 of file return_getAllTransforms.cpp.

◆ start_editing()

void return_getAllTransforms::Editor::start_editing ( )

Definition at line 134 of file return_getAllTransforms.cpp.

◆ state()

return_getAllTransforms & return_getAllTransforms::Editor::state ( )

Definition at line 128 of file return_getAllTransforms.cpp.

◆ stop_editing()

void return_getAllTransforms::Editor::stop_editing ( )

Definition at line 140 of file return_getAllTransforms.cpp.

◆ will_set_retvalue()

bool return_getAllTransforms::Editor::will_set_retvalue ( )
virtual

Definition at line 164 of file return_getAllTransforms.cpp.

◆ will_set_transforms_list()

bool return_getAllTransforms::Editor::will_set_transforms_list ( )
virtual

Definition at line 202 of file return_getAllTransforms.cpp.

◆ write()

bool return_getAllTransforms::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
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::PortWriter.

Definition at line 338 of file return_getAllTransforms.cpp.


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