wpi::sim::AnalogInputSim Class Reference

Class to control a simulated analog input. More...

#include <wpi/simulation/AnalogInputSim.hpp>

Public Member Functions
	AnalogInputSim (const AnalogInput &analogInput)
	Constructs from an AnalogInput object.
	AnalogInputSim (int channel)
	Constructs from an analog input channel number.
std::unique_ptr< CallbackStore >	RegisterInitializedCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on whether the analog input is initialized.
bool	GetInitialized () const
	Check if this analog input has been initialized.
void	SetInitialized (bool initialized)
	Change whether this analog input has been initialized.
std::unique_ptr< CallbackStore >	RegisterVoltageCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on the voltage.
double	GetVoltage () const
	Get the voltage.
void	SetVoltage (double voltage)
	Change the voltage.
void	ResetData ()
	Reset all simulation data for this object.

Detailed Description

Class to control a simulated analog input.

Constructor & Destructor Documentation

AnalogInputSim() [1/2]

wpi::sim::AnalogInputSim::AnalogInputSim ( const AnalogInput & analogInput )

explicit

Constructs from an AnalogInput object.

Parameters

analogInput

AnalogInput to simulate

AnalogInputSim() [2/2]

wpi::sim::AnalogInputSim::AnalogInputSim ( int channel )

explicit

Constructs from an analog input channel number.

Parameters

channel

Channel number

Member Function Documentation

GetInitialized()

bool wpi::sim::AnalogInputSim::GetInitialized

(

)

const

Check if this analog input has been initialized.

Returns

true if initialized

GetVoltage()

double wpi::sim::AnalogInputSim::GetVoltage

(

)

const

Get the voltage.

Returns

the voltage

RegisterInitializedCallback()

std::unique_ptr< CallbackStore > wpi::sim::AnalogInputSim::RegisterInitializedCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback on whether the analog input is initialized.

Parameters

callback	the callback that will be called whenever the analog input is initialized
initialNotify	if true, the callback will be run on the initial value

Returns

the CallbackStore object associated with this callback

RegisterVoltageCallback()

std::unique_ptr< CallbackStore > wpi::sim::AnalogInputSim::RegisterVoltageCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback on the voltage.

Parameters

callback	the callback that will be called whenever the voltage is changed
initialNotify	if true, the callback will be run on the initial value

Returns

the CallbackStore object associated with this callback

ResetData()

void wpi::sim::AnalogInputSim::ResetData

(

)

Reset all simulation data for this object.

SetInitialized()

void wpi::sim::AnalogInputSim::SetInitialized

(

bool

initialized

)

Change whether this analog input has been initialized.

Parameters

initialized

the new value

SetVoltage()

void wpi::sim::AnalogInputSim::SetVoltage

(

double

voltage

)

Change the voltage.

Parameters

voltage

the new value

---

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

• wpi/simulation/AnalogInputSim.hpp