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

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

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

Public Member Functions

 CANdiSimState (hardware::core::CoreCANdi const &device)
 Creates an object to control the state of the given hardware::CANdi.
 
 CANdiSimState (CANdiSimState const &)=delete
 
 CANdiSimState (CANdiSimState &&)=default
 
CANdiSimStateoperator= (CANdiSimState const &)=delete
 
CANdiSimStateoperator= (CANdiSimState &&)=default
 
ctre::phoenix::StatusCode SetSupplyVoltage (units::voltage::volt_t volts)
 Sets the simulated supply voltage of the CANdi.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CANdiSimState() [1/3]

ctre::phoenix6::sim::CANdiSimState::CANdiSimState ( hardware::core::CoreCANdi const & device)

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

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

Parameters
deviceDevice to which this simulation state is attached

◆ CANdiSimState() [2/3]

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

◆ CANdiSimState() [3/3]

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

Member Function Documentation

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ SetSupplyVoltage()

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

Sets the simulated supply voltage of the CANdi.

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: