gazebo-yarp-plugins
Gazebo Plugins exposing YARP interfaces.
Loading...
Searching...
No Matches
GazeboYarpPlugins::ClockServer_stepSimulation_helper Class Reference
Inheritance diagram for GazeboYarpPlugins::ClockServer_stepSimulation_helper:
Collaboration diagram for GazeboYarpPlugins::ClockServer_stepSimulation_helper:

Classes

class  Command
 
class  Reply
 

Public Types

using funcptr_t = void (*)(const std::int32_t)
 
using funcptr_t = void (*)(const std::int32_t)
 

Public Member Functions

 ClockServer_stepSimulation_helper ()=default
 
 ClockServer_stepSimulation_helper (const std::int32_t numberOfSteps)
 
bool write (yarp::os::ConnectionWriter &connection) const override
 
bool read (yarp::os::ConnectionReader &connection) override
 
void call (ClockServer *ptr) const
 
 ClockServer_stepSimulation_helper ()=default
 
 ClockServer_stepSimulation_helper (const std::int32_t numberOfSteps)
 
bool write (yarp::os::ConnectionWriter &connection) const override
 
bool read (yarp::os::ConnectionReader &connection) override
 
void call (ClockServer *ptr) const
 

Public Attributes

Command cmd
 
Reply reply
 

Static Public Attributes

static constexpr const char * s_tag {"stepSimulation"}
 
static constexpr size_t s_tag_len {1}
 
static constexpr size_t s_cmd_len {2}
 
static constexpr size_t s_reply_len {0}
 
static constexpr const char * s_prototype {"void ClockServer::stepSimulation(const std::int32_t numberOfSteps)"}
 
static constexpr const char * s_help
 

Member Typedef Documentation

◆ funcptr_t [1/2]

◆ funcptr_t [2/2]

Constructor & Destructor Documentation

◆ ClockServer_stepSimulation_helper() [1/4]

GazeboYarpPlugins::ClockServer_stepSimulation_helper::ClockServer_stepSimulation_helper ( )
default

◆ ClockServer_stepSimulation_helper() [2/4]

GazeboYarpPlugins::ClockServer_stepSimulation_helper::ClockServer_stepSimulation_helper ( const std::int32_t numberOfSteps)
explicit

◆ ClockServer_stepSimulation_helper() [3/4]

GazeboYarpPlugins::ClockServer_stepSimulation_helper::ClockServer_stepSimulation_helper ( )
default

◆ ClockServer_stepSimulation_helper() [4/4]

GazeboYarpPlugins::ClockServer_stepSimulation_helper::ClockServer_stepSimulation_helper ( const std::int32_t numberOfSteps)
explicit

Member Function Documentation

◆ write() [1/2]

bool GazeboYarpPlugins::ClockServer_stepSimulation_helper::write ( yarp::os::ConnectionWriter & connection) const
override

◆ read() [1/2]

bool GazeboYarpPlugins::ClockServer_stepSimulation_helper::read ( yarp::os::ConnectionReader & connection)
override

◆ call() [1/2]

void GazeboYarpPlugins::ClockServer_stepSimulation_helper::call ( ClockServer * ptr) const

◆ write() [2/2]

bool GazeboYarpPlugins::ClockServer_stepSimulation_helper::write ( yarp::os::ConnectionWriter & connection) const
override

◆ read() [2/2]

bool GazeboYarpPlugins::ClockServer_stepSimulation_helper::read ( yarp::os::ConnectionReader & connection)
override

◆ call() [2/2]

void GazeboYarpPlugins::ClockServer_stepSimulation_helper::call ( ClockServer * ptr) const

Member Data Documentation

◆ cmd

Command GazeboYarpPlugins::ClockServer_stepSimulation_helper::cmd

◆ reply

Reply GazeboYarpPlugins::ClockServer_stepSimulation_helper::reply

◆ s_tag

static constexpr const char * GazeboYarpPlugins::ClockServer_stepSimulation_helper::s_tag {"stepSimulation"}
staticconstexpr

◆ s_tag_len

static constexpr size_t GazeboYarpPlugins::ClockServer_stepSimulation_helper::s_tag_len {1}
staticconstexpr

◆ s_cmd_len

static constexpr size_t GazeboYarpPlugins::ClockServer_stepSimulation_helper::s_cmd_len {2}
staticconstexpr

◆ s_reply_len

static constexpr size_t GazeboYarpPlugins::ClockServer_stepSimulation_helper::s_reply_len {0}
staticconstexpr

◆ s_prototype

static constexpr const char * GazeboYarpPlugins::ClockServer_stepSimulation_helper::s_prototype {"void ClockServer::stepSimulation(const std::int32_t numberOfSteps)"}
staticconstexpr

◆ s_help

static constexpr const char * GazeboYarpPlugins::ClockServer_stepSimulation_helper::s_help
staticconstexpr
Initial value:
{
"Steps the simulation for the provided number of steps.\n"
"The input parameter is the number of steps, not the time (Usually 1 step = 1ms but this is not guaranteed)\n"
"@note: this function (will be) not blocking, i.e. it will return immediately. Currently calling this function\n"
"twice before the previous call actually ends its computation gives and undefined behavior.\n"
"@param numberOfSteps number of steps to simulate"
}

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