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)
	~SolenoidSim ()=default
bool	GetOutput () const
void	SetOutput (bool output)
std::unique_ptr< CallbackStore >	RegisterOutputCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run when the output of this solenoid has changed.
std::shared_ptr< PneumaticsBaseSim >	GetModuleSim () 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()

frc::sim::SolenoidSim::~SolenoidSim ( )

default

Member Function Documentation

GetModuleSim()

std::shared_ptr< PneumaticsBaseSim > frc::sim::SolenoidSim::GetModuleSim

(

)

const

GetOutput()

bool frc::sim::SolenoidSim::GetOutput

(

)

const

RegisterOutputCallback()

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

nodiscard

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

Parameters

callback	the callback
initialNotify	whether 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:

• frc/simulation/SolenoidSim.h