CTRE Phoenix 6 C++ 24.3.0
ctre::phoenix6::controls::MusicTone Class Reference

Plays a single tone at the user specified frequency. More...

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

Inheritance diagram for ctre::phoenix6::controls::MusicTone:
ctre::phoenix6::controls::ControlRequest

Public Member Functions

 MusicTone (units::frequency::hertz_t AudioFrequency)
 Plays a single tone at the user specified frequency. More...
 
MusicToneWithAudioFrequency (units::frequency::hertz_t newAudioFrequency)
 Modifies this Control Request's AudioFrequency parameter and returns itself for method-chaining and easier to use request API. More...
 
MusicToneWithUpdateFreqHz (units::frequency::hertz_t newUpdateFreqHz)
 Sets the period at which this control will update at. More...
 
std::string ToString () const override
 Returns a string representation of the object. More...
 
std::map< std::string, std::string > GetControlInfo () const override
 Gets information about this control request. More...
 
- Public Member Functions inherited from ctre::phoenix6::controls::ControlRequest
 ControlRequest (std::string name)
 Constructs a new Control Request with the given name. More...
 
std::string const & GetName () const
 
virtual std::map< std::string, std::string > GetControlInfo () const =0
 Gets information about this control request. More...
 
virtual ~ControlRequest ()=default
 
virtual std::string ToString () const =0
 

Public Attributes

units::frequency::hertz_t AudioFrequency
 Sound frequency to play. More...
 
units::frequency::hertz_t UpdateFreqHz {100_Hz}
 The period at which this control will update at. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ctre::phoenix6::controls::ControlRequest
 ControlRequest (ControlRequest const &)=default
 
 ControlRequest (ControlRequest &&)=default
 
ControlRequestoperator= (ControlRequest const &)=default
 
ControlRequestoperator= (ControlRequest &&)=default
 
- Protected Attributes inherited from ctre::phoenix6::controls::ControlRequest
std::string name
 

Detailed Description

Plays a single tone at the user specified frequency.

Constructor & Destructor Documentation

◆ MusicTone()

ctre::phoenix6::controls::MusicTone::MusicTone ( units::frequency::hertz_t  AudioFrequency)
inline

Plays a single tone at the user specified frequency.

Parameters
AudioFrequencySound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000Hz. Any nonzero frequency less than 10 Hz will be capped to 10Hz. Any frequency above 20Khz will be capped to 20KHz.

Member Function Documentation

◆ GetControlInfo()

std::map< std::string, std::string > ctre::phoenix6::controls::MusicTone::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::MusicTone::ToString ( ) const
inlineoverridevirtual

Returns a string representation of the object.

Returns
a string representation of the object.

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

◆ WithAudioFrequency()

MusicTone & ctre::phoenix6::controls::MusicTone::WithAudioFrequency ( units::frequency::hertz_t  newAudioFrequency)
inline

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

Sound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000Hz. Any nonzero frequency less than 10 Hz will be capped to 10Hz. Any frequency above 20Khz will be capped to 20KHz.

Parameters
newAudioFrequencyParameter to modify
Returns
Itself

◆ WithUpdateFreqHz()

MusicTone & ctre::phoenix6::controls::MusicTone::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
newUpdateFreqHzParameter to modify
Returns
Itself

Member Data Documentation

◆ AudioFrequency

units::frequency::hertz_t ctre::phoenix6::controls::MusicTone::AudioFrequency

Sound frequency to play.

A value of zero will silence the device. The effective frequency range is 10-20000Hz. Any nonzero frequency less than 10 Hz will be capped to 10Hz. Any frequency above 20Khz will be capped to 20KHz.

◆ UpdateFreqHz

units::frequency::hertz_t ctre::phoenix6::controls::MusicTone::UpdateFreqHz {100_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: