JMotor/_j_drivetrain_basic_8h_source.html

#ifndef J_DRIVETRAIN_BASIC_H

#define J_DRIVETRAIN_BASIC_H

#include "JTwoDTransform.h"

#include <Arduino.h>


class JDrivetrainBasic {

public:

    virtual void run() = 0;

    virtual bool setEnable(bool _enable) = 0;

    virtual bool enable() = 0;

    virtual bool disable() = 0;

    virtual bool getEnable() = 0;

    virtual void setVel(JTwoDTransform _vel, bool _run = false) = 0;

    virtual JTwoDTransform getMaxVel() = 0;

};


#endif // J_DRIVETRAIN_BASIC_H

JTwoDTransform.h

JDrivetrainBasic
interface for a drivetrain with only simple velocity control
Definition JDrivetrainBasic.h:8

JDrivetrainBasic::getEnable
virtual bool getEnable()=0
gets the current state (enabled or disabled)

JDrivetrainBasic::setVel
virtual void setVel(JTwoDTransform _vel, bool _run=false)=0
sets a velocity for the drivetrain to move at

JDrivetrainBasic::enable
virtual bool enable()=0
enables movement

JDrivetrainBasic::run
virtual void run()=0
call this in loop. it calls any encoder or motor update functions

JDrivetrainBasic::setEnable
virtual bool setEnable(bool _enable)=0
enables or disables movement

JDrivetrainBasic::getMaxVel
virtual JTwoDTransform getMaxVel()=0
returns the approximate maximum velocity of the drivetrain, if the drivetrain is told to move at max ...

JDrivetrainBasic::disable
virtual bool disable()=0
disables movement

JTwoDTransform
struct for storing a 2 dimensional transformation. Used for telling a drivetrain how to move.
Definition JTwoDTransform.h:9