WPILibC++ 2024.3.2
frc::sim::SolenoidSim Class Reference

#include <frc/simulation/SolenoidSim.h>

Public Member Functions

 SolenoidSim (std::shared_ptr< PneumaticsBaseSim > moduleSim, int channel)
 
 SolenoidSim (int module, PneumaticsModuleType type, int channel)
 
 SolenoidSim (PneumaticsModuleType type, int channel)
 
virtual ~SolenoidSim ()=default
 
bool GetOutput () const
 
void SetOutput (bool output)
 
virtual std::unique_ptr< CallbackStoreRegisterOutputCallback (NotifyCallback callback, bool initialNotify)
 Register a callback to be run when the output of this solenoid has changed. More...
 
std::shared_ptr< PneumaticsBaseSimGetModuleSim () const
 

Constructor & Destructor Documentation

◆ SolenoidSim() [1/3]

frc::sim::SolenoidSim::SolenoidSim ( std::shared_ptr< PneumaticsBaseSim moduleSim,
int  channel 
)

◆ SolenoidSim() [2/3]

frc::sim::SolenoidSim::SolenoidSim ( int  module,
PneumaticsModuleType  type,
int  channel 
)

◆ SolenoidSim() [3/3]

frc::sim::SolenoidSim::SolenoidSim ( PneumaticsModuleType  type,
int  channel 
)

◆ ~SolenoidSim()

virtual frc::sim::SolenoidSim::~SolenoidSim ( )
virtualdefault

Member Function Documentation

◆ GetModuleSim()

std::shared_ptr< PneumaticsBaseSim > frc::sim::SolenoidSim::GetModuleSim ( ) const

◆ GetOutput()

bool frc::sim::SolenoidSim::GetOutput ( ) const

◆ RegisterOutputCallback()

virtual std::unique_ptr< CallbackStore > frc::sim::SolenoidSim::RegisterOutputCallback ( NotifyCallback  callback,
bool  initialNotify 
)
virtual

Register a callback to be run when the output of this solenoid has changed.

Parameters
callbackthe callback
initialNotifywhether to run the callback with the initial state
Returns
the CallbackStore object associated with this callback. Save a reference to this object; it being deconstructed cancels the callback.

◆ SetOutput()

void frc::sim::SolenoidSim::SetOutput ( bool  output)

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