CTRE Phoenix Pro C++ 23.0.12
Public Member Functions | Public Attributes | Static Public Attributes | Friends | List of all members
ctre::phoenixpro::signals::ControlModeValue Class Reference

The active control mode of the motor controller. More...

#include <ctre/phoenixpro/signals/SpnEnums.hpp>

Inheritance diagram for ctre::phoenixpro::signals::ControlModeValue:
ctre::phoenixpro::ISerializable

Public Member Functions

 ControlModeValue (int value)
 
 ControlModeValue ()
 
std::string ToString () const
 Gets the string representation of this enum. More...
 
std::string Serialize () const
 
bool operator== (const ControlModeValue &data) const
 
bool operator== (int data) const
 
bool operator< (const ControlModeValue &data) const
 
bool operator< (int data) const
 
virtual std::string Serialize () const =0
 

Public Attributes

int value
 

Static Public Attributes

static constexpr int DisabledOutput = 0
 
static constexpr int NeutralOut = 1
 
static constexpr int StaticBrake = 2
 
static constexpr int DutyCycleOut = 3
 
static constexpr int PositionDutyCycle = 4
 
static constexpr int VelocityDutyCycle = 5
 
static constexpr int MotionMagicDutyCycle = 6
 
static constexpr int DutyCycleFOC = 7
 
static constexpr int PositionDutyCycleFOC = 8
 
static constexpr int VelocityDutyCycleFOC = 9
 
static constexpr int MotionMagicDutyCycleFOC = 10
 
static constexpr int VoltageOut = 11
 
static constexpr int PositionVoltage = 12
 
static constexpr int VelocityVoltage = 13
 
static constexpr int MotionMagicVoltage = 14
 
static constexpr int VoltageFOC = 15
 
static constexpr int PositionVoltageFOC = 16
 
static constexpr int VelocityVoltageFOC = 17
 
static constexpr int MotionMagicVoltageFOC = 18
 
static constexpr int TorqueCurrentFOC = 19
 
static constexpr int PositionTorqueCurrentFOC = 20
 
static constexpr int VelocityTorqueCurrentFOC = 21
 
static constexpr int MotionMagicTorqueCurrentFOC = 22
 
static constexpr int Follower = 23
 
static constexpr int Reserved = 24
 
static constexpr int CoastOut = 25
 

Friends

std::ostream & operator<< (std::ostream &os, const ControlModeValue &data)
 

Detailed Description

The active control mode of the motor controller.

Constructor & Destructor Documentation

◆ ControlModeValue() [1/2]

ctre::phoenixpro::signals::ControlModeValue::ControlModeValue ( int  value)
inline

◆ ControlModeValue() [2/2]

ctre::phoenixpro::signals::ControlModeValue::ControlModeValue ( )
inline

Member Function Documentation

◆ operator<() [1/2]

bool ctre::phoenixpro::signals::ControlModeValue::operator< ( const ControlModeValue &  data) const
inline

◆ operator<() [2/2]

bool ctre::phoenixpro::signals::ControlModeValue::operator< ( int  data) const
inline

◆ operator==() [1/2]

bool ctre::phoenixpro::signals::ControlModeValue::operator== ( const ControlModeValue &  data) const
inline

◆ operator==() [2/2]

bool ctre::phoenixpro::signals::ControlModeValue::operator== ( int  data) const
inline

◆ Serialize()

std::string ctre::phoenixpro::signals::ControlModeValue::Serialize ( ) const
inlinevirtual

Implements ctre::phoenixpro::ISerializable.

◆ ToString()

std::string ctre::phoenixpro::signals::ControlModeValue::ToString ( ) const
inline

Gets the string representation of this enum.

Returns
String representation of this enum

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const ControlModeValue &  data 
)
friend

Member Data Documentation

◆ CoastOut

constexpr int ctre::phoenixpro::signals::ControlModeValue::CoastOut = 25
staticconstexpr

◆ DisabledOutput

constexpr int ctre::phoenixpro::signals::ControlModeValue::DisabledOutput = 0
staticconstexpr

◆ DutyCycleFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::DutyCycleFOC = 7
staticconstexpr

◆ DutyCycleOut

constexpr int ctre::phoenixpro::signals::ControlModeValue::DutyCycleOut = 3
staticconstexpr

◆ Follower

constexpr int ctre::phoenixpro::signals::ControlModeValue::Follower = 23
staticconstexpr

◆ MotionMagicDutyCycle

constexpr int ctre::phoenixpro::signals::ControlModeValue::MotionMagicDutyCycle = 6
staticconstexpr

◆ MotionMagicDutyCycleFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::MotionMagicDutyCycleFOC = 10
staticconstexpr

◆ MotionMagicTorqueCurrentFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::MotionMagicTorqueCurrentFOC = 22
staticconstexpr

◆ MotionMagicVoltage

constexpr int ctre::phoenixpro::signals::ControlModeValue::MotionMagicVoltage = 14
staticconstexpr

◆ MotionMagicVoltageFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::MotionMagicVoltageFOC = 18
staticconstexpr

◆ NeutralOut

constexpr int ctre::phoenixpro::signals::ControlModeValue::NeutralOut = 1
staticconstexpr

◆ PositionDutyCycle

constexpr int ctre::phoenixpro::signals::ControlModeValue::PositionDutyCycle = 4
staticconstexpr

◆ PositionDutyCycleFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::PositionDutyCycleFOC = 8
staticconstexpr

◆ PositionTorqueCurrentFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::PositionTorqueCurrentFOC = 20
staticconstexpr

◆ PositionVoltage

constexpr int ctre::phoenixpro::signals::ControlModeValue::PositionVoltage = 12
staticconstexpr

◆ PositionVoltageFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::PositionVoltageFOC = 16
staticconstexpr

◆ Reserved

constexpr int ctre::phoenixpro::signals::ControlModeValue::Reserved = 24
staticconstexpr

◆ StaticBrake

constexpr int ctre::phoenixpro::signals::ControlModeValue::StaticBrake = 2
staticconstexpr

◆ TorqueCurrentFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::TorqueCurrentFOC = 19
staticconstexpr

◆ value

int ctre::phoenixpro::signals::ControlModeValue::value

◆ VelocityDutyCycle

constexpr int ctre::phoenixpro::signals::ControlModeValue::VelocityDutyCycle = 5
staticconstexpr

◆ VelocityDutyCycleFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::VelocityDutyCycleFOC = 9
staticconstexpr

◆ VelocityTorqueCurrentFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::VelocityTorqueCurrentFOC = 21
staticconstexpr

◆ VelocityVoltage

constexpr int ctre::phoenixpro::signals::ControlModeValue::VelocityVoltage = 13
staticconstexpr

◆ VelocityVoltageFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::VelocityVoltageFOC = 17
staticconstexpr

◆ VoltageFOC

constexpr int ctre::phoenixpro::signals::ControlModeValue::VoltageFOC = 15
staticconstexpr

◆ VoltageOut

constexpr int ctre::phoenixpro::signals::ControlModeValue::VoltageOut = 11
staticconstexpr
The documentation for this class was generated from the following file: