signals-cpp
Loading...
Searching...
No Matches
TranslationalDynamicsBase< IST, SST, SDST, d, PT > Struct Template Reference

Base class for defining the dynamics for 1D, 2D, and 3D point masses. More...

#include <Models.h>

Public Types

using InputSignalType = IST
 
using StateDotSignalType = SST
 
using StateSignalType = SDST
 
using InputType = typename InputSignalType::BaseType
 
using StateType = typename StateSignalType::BaseType
 
using StateDotType = typename StateDotSignalType::BaseType
 
using StateDotDotType = typename StateDotSignalType::TangentType
 
using ParamsType = PT
 

Static Public Member Functions

static bool update (StateDotSignalType &xdot, const StateSignalType &x, const InputSignalType &u, const double &t0, const double &tf, const ParamsType &params, const bool &insertIntoHistory=false, const bool &calculateXddot=false)
 Update a provided state time derivative given an input and time interval.
 

Detailed Description

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
struct TranslationalDynamicsBase< IST, SST, SDST, d, PT >

Base class for defining the dynamics for 1D, 2D, and 3D point masses.

Member Typedef Documentation

◆ InputSignalType

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
using TranslationalDynamicsBase< IST, SST, SDST, d, PT >::InputSignalType = IST

◆ InputType

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
using TranslationalDynamicsBase< IST, SST, SDST, d, PT >::InputType = typename InputSignalType::BaseType

◆ ParamsType

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
using TranslationalDynamicsBase< IST, SST, SDST, d, PT >::ParamsType = PT

◆ StateDotDotType

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
using TranslationalDynamicsBase< IST, SST, SDST, d, PT >::StateDotDotType = typename StateDotSignalType::TangentType

◆ StateDotSignalType

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
using TranslationalDynamicsBase< IST, SST, SDST, d, PT >::StateDotSignalType = SST

◆ StateDotType

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
using TranslationalDynamicsBase< IST, SST, SDST, d, PT >::StateDotType = typename StateDotSignalType::BaseType

◆ StateSignalType

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
using TranslationalDynamicsBase< IST, SST, SDST, d, PT >::StateSignalType = SDST

◆ StateType

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
using TranslationalDynamicsBase< IST, SST, SDST, d, PT >::StateType = typename StateSignalType::BaseType

Member Function Documentation

◆ update()

template<typename IST, typename SST, typename SDST, size_t d, typename PT>
static bool TranslationalDynamicsBase< IST, SST, SDST, d, PT >::update ( StateDotSignalType & xdot,
const StateSignalType & x,
const InputSignalType & u,
const double & t0,
const double & tf,
const ParamsType & params,
const bool & insertIntoHistory = false,
const bool & calculateXddot = false )
inlinestatic

Update a provided state time derivative given an input and time interval.

Parameters
xdotThe state time derivative signal to update.
xThe state signal to reference for the dynamics.
uThe input signal to reference for the dynamics.
t0The time at which to sample the state and input.
tfThe time at which to modify the state time derivative.
paramsThe rigid body model parameters.
insertIntoHistoryWhether to insert the answer into state time derivative signal history.
calculateXddotWhether to use finite differencing to calculate the second time derivative of the state.

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