WPILibC++ 2025.0.0-alpha-1-10-g1ccd8d1
frc::sim::DutyCycleEncoderSim Class Reference

Class to control a simulated duty cycle encoder. More...

#include <frc/simulation/DutyCycleEncoderSim.h>

Public Member Functions

 DutyCycleEncoderSim (const DutyCycleEncoder &encoder)
 Constructs from a DutyCycleEncoder object. More...
 
 DutyCycleEncoderSim (int channel)
 Constructs from a digital input channel. More...
 
double Get ()
 Get the position. More...
 
void Set (double value)
 Set the position. More...
 
bool IsConnected ()
 Get if the encoder is connected. More...
 
void SetConnected (bool isConnected)
 Set if the encoder is connected. More...
 

Detailed Description

Class to control a simulated duty cycle encoder.

Constructor & Destructor Documentation

◆ DutyCycleEncoderSim() [1/2]

frc::sim::DutyCycleEncoderSim::DutyCycleEncoderSim ( const DutyCycleEncoder encoder)
explicit

Constructs from a DutyCycleEncoder object.

Parameters
encoderDutyCycleEncoder to simulate

◆ DutyCycleEncoderSim() [2/2]

frc::sim::DutyCycleEncoderSim::DutyCycleEncoderSim ( int  channel)
explicit

Constructs from a digital input channel.

Parameters
channeldigital input channel

Member Function Documentation

◆ Get()

double frc::sim::DutyCycleEncoderSim::Get ( )

Get the position.

Returns
The position.

◆ IsConnected()

bool frc::sim::DutyCycleEncoderSim::IsConnected ( )

Get if the encoder is connected.

Returns
true if the encoder is connected.

◆ Set()

void frc::sim::DutyCycleEncoderSim::Set ( double  value)

Set the position.

Parameters
valueThe position.

◆ SetConnected()

void frc::sim::DutyCycleEncoderSim::SetConnected ( bool  isConnected)

Set if the encoder is connected.

Parameters
isConnectedWhether or not the sensor is connected.

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