YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
WorldInterfaceServer_makeFrame_helper::Command Class Reference
+ Inheritance diagram for WorldInterfaceServer_makeFrame_helper::Command:

Public Member Functions

 Command ()=default
 
 Command (const double size, const Pose &pose, const Color &color, const std::string &frame_name, const std::string &object_name, const bool gravity_enable, const bool collision_enable)
 
 ~Command () override=default
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool writeTag (const yarp::os::idl::WireWriter &writer) const
 
bool writeArgs (const yarp::os::idl::WireWriter &writer) const
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool readTag (yarp::os::idl::WireReader &reader)
 
bool readArgs (yarp::os::idl::WireReader &reader)
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- Public Member Functions inherited from yarp::os::Portable
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor.
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations.
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations.
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

double size {0.0}
 
Pose pose {}
 
Color color {}
 
std::string frame_name {""}
 
std::string object_name {""}
 
bool gravity_enable {false}
 
bool collision_enable {true}
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (const PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading.
 

Detailed Description

Definition at line 328 of file WorldInterfaceServer.cpp.

Constructor & Destructor Documentation

◆ Command() [1/2]

WorldInterfaceServer_makeFrame_helper::Command::Command ( )
default

◆ Command() [2/2]

WorldInterfaceServer_makeFrame_helper::Command::Command ( const double  size,
const Pose &  pose,
const Color &  color,
const std::string &  frame_name,
const std::string &  object_name,
const bool  gravity_enable,
const bool  collision_enable 
)

Definition at line 1864 of file WorldInterfaceServer.cpp.

◆ ~Command()

WorldInterfaceServer_makeFrame_helper::Command::~Command ( )
overridedefault

Member Function Documentation

◆ read() [1/2]

bool WorldInterfaceServer_makeFrame_helper::Command::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::Portable.

Definition at line 1884 of file WorldInterfaceServer.cpp.

◆ read() [2/2]

bool WorldInterfaceServer_makeFrame_helper::Command::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 1939 of file WorldInterfaceServer.cpp.

◆ readArgs()

bool WorldInterfaceServer_makeFrame_helper::Command::readArgs ( yarp::os::idl::WireReader &  reader)

Definition at line 1963 of file WorldInterfaceServer.cpp.

◆ readTag()

bool WorldInterfaceServer_makeFrame_helper::Command::readTag ( yarp::os::idl::WireReader &  reader)

Definition at line 1950 of file WorldInterfaceServer.cpp.

◆ write() [1/2]

bool WorldInterfaceServer_makeFrame_helper::Command::write ( const yarp::os::idl::WireWriter &  writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 1894 of file WorldInterfaceServer.cpp.

◆ write() [2/2]

bool WorldInterfaceServer_makeFrame_helper::Command::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::Portable.

Definition at line 1875 of file WorldInterfaceServer.cpp.

◆ writeArgs()

bool WorldInterfaceServer_makeFrame_helper::Command::writeArgs ( const yarp::os::idl::WireWriter &  writer) const

Definition at line 1913 of file WorldInterfaceServer.cpp.

◆ writeTag()

bool WorldInterfaceServer_makeFrame_helper::Command::writeTag ( const yarp::os::idl::WireWriter &  writer) const

Definition at line 1905 of file WorldInterfaceServer.cpp.

Member Data Documentation

◆ collision_enable

bool WorldInterfaceServer_makeFrame_helper::Command::collision_enable {true}

Definition at line 354 of file WorldInterfaceServer.cpp.

◆ color

Color WorldInterfaceServer_makeFrame_helper::Command::color {}

Definition at line 350 of file WorldInterfaceServer.cpp.

◆ frame_name

std::string WorldInterfaceServer_makeFrame_helper::Command::frame_name {""}

Definition at line 351 of file WorldInterfaceServer.cpp.

◆ gravity_enable

bool WorldInterfaceServer_makeFrame_helper::Command::gravity_enable {false}

Definition at line 353 of file WorldInterfaceServer.cpp.

◆ object_name

std::string WorldInterfaceServer_makeFrame_helper::Command::object_name {""}

Definition at line 352 of file WorldInterfaceServer.cpp.

◆ pose

Pose WorldInterfaceServer_makeFrame_helper::Command::pose {}

Definition at line 349 of file WorldInterfaceServer.cpp.

◆ size

double WorldInterfaceServer_makeFrame_helper::Command::size {0.0}

Definition at line 348 of file WorldInterfaceServer.cpp.


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