robotoc
robotoc - efficient ROBOT Optimal Control solvers
Loading...
Searching...
No Matches
robotoc::SolutionInterpolator Class Reference

Solution interpolator. More...

#include <solution_interpolator.hpp>

Public Member Functions

 SolutionInterpolator (const InterpolationOrder order=InterpolationOrder::Linear)
 Constructor. More...
 
 ~SolutionInterpolator ()=default
 Default destructor. More...
 
 SolutionInterpolator (const SolutionInterpolator &)=default
 Default copy constructor. More...
 
SolutionInterpolatoroperator= (const SolutionInterpolator &)=default
 Default copy assign operator. More...
 
 SolutionInterpolator (SolutionInterpolator &&) noexcept=default
 Default move constructor. More...
 
SolutionInterpolatoroperator= (SolutionInterpolator &&) noexcept=default
 Default move assign operator. More...
 
void setInterpolationOrder (const InterpolationOrder order)
 
void store (const TimeDiscretization &time_discretization, const Solution &solution)
 Stores the current time discretization and solution. More...
 
void interpolate (const Robot &robot, const TimeDiscretization &time_discretization, Solution &solution) const
 Interpolates the solution. More...
 
bool hasStoredSolution () const
 Check if this has a stored solution. More...
 

Detailed Description

Solution interpolator.

Constructor & Destructor Documentation

◆ SolutionInterpolator() [1/3]

robotoc::SolutionInterpolator::SolutionInterpolator ( const InterpolationOrder  order = InterpolationOrder::Linear)

Constructor.

Parameters
[in]orderOrder of the interpolation.

◆ ~SolutionInterpolator()

robotoc::SolutionInterpolator::~SolutionInterpolator ( )
default

Default destructor.

◆ SolutionInterpolator() [2/3]

robotoc::SolutionInterpolator::SolutionInterpolator ( const SolutionInterpolator )
default

Default copy constructor.

◆ SolutionInterpolator() [3/3]

robotoc::SolutionInterpolator::SolutionInterpolator ( SolutionInterpolator &&  )
defaultnoexcept

Default move constructor.

Member Function Documentation

◆ hasStoredSolution()

bool robotoc::SolutionInterpolator::hasStoredSolution ( ) const
inline

Check if this has a stored solution.

Returns
true if this has a stored solution.

◆ interpolate()

void robotoc::SolutionInterpolator::interpolate ( const Robot robot,
const TimeDiscretization time_discretization,
Solution solution 
) const

Interpolates the solution.

Parameters
[in]robotRobot model.
[in]time_discretizationTime discretization.
[out]solutionSolution.

◆ operator=() [1/2]

SolutionInterpolator & robotoc::SolutionInterpolator::operator= ( const SolutionInterpolator )
default

Default copy assign operator.

◆ operator=() [2/2]

SolutionInterpolator & robotoc::SolutionInterpolator::operator= ( SolutionInterpolator &&  )
defaultnoexcept

Default move assign operator.

◆ setInterpolationOrder()

void robotoc::SolutionInterpolator::setInterpolationOrder ( const InterpolationOrder  order)

◆ store()

void robotoc::SolutionInterpolator::store ( const TimeDiscretization time_discretization,
const Solution solution 
)

Stores the current time discretization and solution.

Parameters
[in]time_discretizationTime discretization.
[out]solutionSolution.

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