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
	EmptyAnimation (int Slot)
	An empty animation, clearing any animation in the specified slot.
EmptyAnimation &	WithSlot (int newSlot)
	Modifies this Control Request's Slot parameter and returns itself for method-chaining and easier to use request API.
EmptyAnimation &	WithUpdateFreqHz (units::frequency::hertz_t newUpdateFreqHz)
	Sets the period at which this control will update at.
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
	ControlRequest (std::string name)
	Constructs a new Control Request with the given name.
std::string const &	GetName () const
virtual	~ControlRequest ()=default

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

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

Detailed Description

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

Constructor & Destructor Documentation

EmptyAnimation()

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

inline

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.

Member Function Documentation

GetControlInfo()

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

inlineoverridevirtual

Gets information about this control request.

Returns

Map of control parameter names and corresponding applied values

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

ToString()

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

inlineoverridevirtual

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 )

inline

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 )

inline

Sets the period at which this control will update at.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

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 period at which this control will update at.

This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms).

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