ctre::phoenix6::controls::EmptyAnimation Class Reference

An empty animation, clearing any animation in the specified slot. More...

#include <ctre/phoenix6/controls/EmptyAnimation.hpp>

Inheritance diagram for ctre::phoenix6::controls::EmptyAnimation:

Public Member Functions
constexpr	EmptyAnimation (int Slot)
	An empty animation, clearing any animation in the specified slot.
constexpr	~EmptyAnimation () override
constexpr std::string_view	GetName () const override
	Gets the name of this control request.
constexpr EmptyAnimation &	WithSlot (int newSlot)
	Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.
constexpr EmptyAnimation &	WithUpdateFreqHz (units::frequency::hertz_t newUpdateFreqHz)
	Sets the frequency at which this control will update.
std::string	ToString () const override
	Returns a string representation of the object.
std::map< std::string, std::string >	GetControlInfo () const override
	Gets information about this control request.
Public Member Functions inherited from ctre::phoenix6::controls::ControlRequest
constexpr	ControlRequest ()=default
	Constructs a new Control Request.
virtual constexpr	~ControlRequest ()

Public Attributes
int	Slot
	The slot of this animation, within [0, 7].
units::frequency::hertz_t	UpdateFreqHz {0_Hz}
	The frequency at which this control will update.

Additional Inherited Members
Protected Member Functions inherited from ctre::phoenix6::controls::ControlRequest
constexpr	ControlRequest (ControlRequest const &)=default
constexpr	ControlRequest (ControlRequest &&)=default
constexpr ControlRequest &	operator= (ControlRequest const &)=default
constexpr ControlRequest &	operator= (ControlRequest &&)=default

Detailed Description

An empty animation, clearing any animation in the specified slot.

Constructor & Destructor Documentation

EmptyAnimation()

ctre::phoenix6::controls::EmptyAnimation::EmptyAnimation ( int Slot )

inlineconstexpr

An empty animation, clearing any animation in the specified slot.

Parameters

Slot	The slot of this animation, within [0, 7]. Each slot on the CANdle can store and run one animation.

~EmptyAnimation()

ctre::phoenix6::controls::EmptyAnimation::~EmptyAnimation ( )

inlineconstexproverride

Member Function Documentation

GetControlInfo()

std::map< std::string, std::string > ctre::phoenix6::controls::EmptyAnimation::GetControlInfo ( ) const

overridevirtual

Gets information about this control request.

Returns

Map of control parameter names and corresponding applied values

Implements ctre::phoenix6::controls::ControlRequest.

GetName()

std::string_view ctre::phoenix6::controls::EmptyAnimation::GetName ( ) const

inlineconstexproverridevirtual

Gets the name of this control request.

Returns

Name of the control request

Implements ctre::phoenix6::controls::ControlRequest.

ToString()

std::string ctre::phoenix6::controls::EmptyAnimation::ToString ( ) const

overridevirtual

Returns a string representation of the object.

Returns

a string representation of the object.

Implements ctre::phoenix6::controls::ControlRequest.

WithSlot()

EmptyAnimation & ctre::phoenix6::controls::EmptyAnimation::WithSlot ( int newSlot )

inlineconstexpr

Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.

The slot of this animation, within [0, 7]. Each slot on the CANdle can store and run one animation.

Parameters

newSlot

Parameter to modify

Returns

Itself

WithUpdateFreqHz()

EmptyAnimation & ctre::phoenix6::controls::EmptyAnimation::WithUpdateFreqHz ( units::frequency::hertz_t newUpdateFreqHz )

inlineconstexpr

Sets the frequency at which this control will update.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

Parameters

newUpdateFreqHz

Parameter to modify

Returns

Itself

Member Data Documentation

Slot

int ctre::phoenix6::controls::EmptyAnimation::Slot

The slot of this animation, within [0, 7].

Each slot on the CANdle can store and run one animation.

UpdateFreqHz

units::frequency::hertz_t ctre::phoenix6::controls::EmptyAnimation::UpdateFreqHz {0_Hz}

The frequency at which this control will update.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

---

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

• ctre/phoenix6/controls/EmptyAnimation.hpp