CTRE Phoenix 6 C++ 25.3.1
Loading...
Searching...
No Matches
ctre::phoenix6::sim::CANrangeSimState Class Reference

Class to control the state of a simulated hardware::CANrange. More...

#include <ctre/phoenix6/sim/CANrangeSimState.hpp>

Public Member Functions

 CANrangeSimState (hardware::core::CoreCANrange const &device)
 Creates an object to control the state of the given hardware::CANrange.
 
 CANrangeSimState (CANrangeSimState const &)=delete
 
 CANrangeSimState (CANrangeSimState &&)=default
 
CANrangeSimStateoperator= (CANrangeSimState const &)=delete
 
CANrangeSimStateoperator= (CANrangeSimState &&)=default
 
ctre::phoenix::StatusCode SetSupplyVoltage (units::voltage::volt_t volts)
 Sets the simulated supply voltage of the CANrange.
 
ctre::phoenix::StatusCode SetDistance (units::length::meter_t meters)
 Sets the simulated distance of the CANrange.
 

Detailed Description

Class to control the state of a simulated hardware::CANrange.

Constructor & Destructor Documentation

◆ CANrangeSimState() [1/3]

ctre::phoenix6::sim::CANrangeSimState::CANrangeSimState ( hardware::core::CoreCANrange const & device)

Creates an object to control the state of the given hardware::CANrange.

Note the recommended method of accessing simulation features is to use hardware::CANrange::GetSimState.

Parameters
deviceDevice to which this simulation state is attached

◆ CANrangeSimState() [2/3]

ctre::phoenix6::sim::CANrangeSimState::CANrangeSimState ( CANrangeSimState const & )
delete

◆ CANrangeSimState() [3/3]

ctre::phoenix6::sim::CANrangeSimState::CANrangeSimState ( CANrangeSimState && )
default

Member Function Documentation

◆ operator=() [1/2]

CANrangeSimState & ctre::phoenix6::sim::CANrangeSimState::operator= ( CANrangeSimState && )
default

◆ operator=() [2/2]

CANrangeSimState & ctre::phoenix6::sim::CANrangeSimState::operator= ( CANrangeSimState const & )
delete

◆ SetDistance()

ctre::phoenix::StatusCode ctre::phoenix6::sim::CANrangeSimState::SetDistance ( units::length::meter_t meters)

Sets the simulated distance of the CANrange.

Parameters
metersThe distance in meters
Returns
Status code

◆ SetSupplyVoltage()

ctre::phoenix::StatusCode ctre::phoenix6::sim::CANrangeSimState::SetSupplyVoltage ( units::voltage::volt_t volts)

Sets the simulated supply voltage of the CANrange.

The minimum allowed supply voltage is 4 V - values below this will be promoted to 4 V.

Parameters
voltsThe supply voltage in Volts
Returns
Status code

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