CTRE Phoenix 6 C++ 24.2.0
ctre::phoenix6::signals::MotionMagicIsRunningValue Class Reference

Check if Motion Magic® is running. More...

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

Inheritance diagram for ctre::phoenix6::signals::MotionMagicIsRunningValue:
ctre::phoenix6::ISerializable

Public Member Functions

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

Public Attributes

int value
 

Static Public Attributes

static constexpr int Enabled = 1
 
static constexpr int Disabled = 0
 

Friends

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

Detailed Description

Check if Motion Magic® is running.

This is equivalent to checking that the reported control mode is a Motion Magic® based mode.

Constructor & Destructor Documentation

◆ MotionMagicIsRunningValue() [1/2]

ctre::phoenix6::signals::MotionMagicIsRunningValue::MotionMagicIsRunningValue ( int  value)
inline

◆ MotionMagicIsRunningValue() [2/2]

ctre::phoenix6::signals::MotionMagicIsRunningValue::MotionMagicIsRunningValue ( )
inline

Member Function Documentation

◆ operator<() [1/2]

bool ctre::phoenix6::signals::MotionMagicIsRunningValue::operator< ( const MotionMagicIsRunningValue data) const
inline

◆ operator<() [2/2]

bool ctre::phoenix6::signals::MotionMagicIsRunningValue::operator< ( int  data) const
inline

◆ operator==() [1/2]

bool ctre::phoenix6::signals::MotionMagicIsRunningValue::operator== ( const MotionMagicIsRunningValue data) const
inline

◆ operator==() [2/2]

bool ctre::phoenix6::signals::MotionMagicIsRunningValue::operator== ( int  data) const
inline

◆ Serialize()

std::string ctre::phoenix6::signals::MotionMagicIsRunningValue::Serialize ( ) const
inlinevirtual

◆ ToString()

std::string ctre::phoenix6::signals::MotionMagicIsRunningValue::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 MotionMagicIsRunningValue data 
)
friend

Member Data Documentation

◆ Disabled

constexpr int ctre::phoenix6::signals::MotionMagicIsRunningValue::Disabled = 0
staticconstexpr

◆ Enabled

constexpr int ctre::phoenix6::signals::MotionMagicIsRunningValue::Enabled = 1
staticconstexpr

◆ value

int ctre::phoenix6::signals::MotionMagicIsRunningValue::value

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