Gazebo Physics

API Reference

8.0.0
Solver::Implementation< PolicyT > Class Template Referenceabstract

The implementation API for the solver. More...

#include <World.hh>

Public Member Functions

virtual const std::stringGetWorldSolver (const Identity &_id) const =0
 Implementation API for getting the solver.
 
virtual std::size_t GetWorldSolverIterations (const Identity &_id) const =0
 Implementation API for getting the number of solver iterations.
 
virtual void SetWorldSolver (const Identity &_id, const std::string &_solver)=0
 Implementation API for setting the solver.
 
virtual void SetWorldSolverIterations (const Identity &_id, std::size_t _iterations)=0
 Implementation API for setting the number of solver iterations.
 
- Public Member Functions inherited from Feature::Implementation< PolicyT >
virtual ~Implementation ()=default
 Virtual destructor.
 
virtual Identity InitiateEngine (std::size_t engineID=0)=0
 Tell the physics plugin to initiate a physics engine.
 

Detailed Description

template<typename PolicyT>
class gz::physics::Solver::Implementation< PolicyT >

The implementation API for the solver.

Member Function Documentation

◆ GetWorldSolver()

template<typename PolicyT >
virtual const std::string & GetWorldSolver ( const Identity &  _id) const
pure virtual

Implementation API for getting the solver.

Parameters
[in]_idIdentity of the world.
Returns
Name of solver.

◆ GetWorldSolverIterations()

template<typename PolicyT >
virtual std::size_t GetWorldSolverIterations ( const Identity &  _id) const
pure virtual

Implementation API for getting the number of solver iterations.

Parameters
[in]_idIdentity of the world.
Returns
Number of solver iterations.

◆ SetWorldSolver()

template<typename PolicyT >
virtual void SetWorldSolver ( const Identity &  _id,
const std::string _solver 
)
pure virtual

Implementation API for setting the solver.

Parameters
[in]_idIdentity of the world.
[in]_solverName of solver.

◆ SetWorldSolverIterations()

template<typename PolicyT >
virtual void SetWorldSolverIterations ( const Identity &  _id,
std::size_t  _iterations 
)
pure virtual

Implementation API for setting the number of solver iterations.

Parameters
[in]_idIdentity of the world.
[in]_solverNumber of solver iterations.

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