frc::sim::CTREPCMSim Class Reference

Class to control a simulated Pneumatic Control Module (PCM). More...

#include <frc/simulation/CTREPCMSim.h>

Inheritance diagram for frc::sim::CTREPCMSim:

Public Member Functions
	CTREPCMSim ()
	Constructs with the default PCM module number (CAN ID).
	CTREPCMSim (int module)
	Constructs from a PCM module number (CAN ID).
	CTREPCMSim (const PneumaticsBase &pneumatics)
	~CTREPCMSim () override=default
std::unique_ptr< CallbackStore >	RegisterInitializedCallback (NotifyCallback callback, bool initialNotify) override
	Register a callback to be run when the PCM/PH is initialized.
bool	GetInitialized () const override
	Check whether the PCM/PH has been initialized.
void	SetInitialized (bool initialized) override
	Define whether the PCM/PH has been initialized.
std::unique_ptr< CallbackStore >	RegisterSolenoidOutputCallback (int channel, NotifyCallback callback, bool initialNotify) override
	Register a callback to be run when the solenoid output on a channel changes.
bool	GetSolenoidOutput (int channel) const override
	Check the solenoid output on a specific channel.
void	SetSolenoidOutput (int channel, bool solenoidOutput) override
	Change the solenoid output on a specific channel.
std::unique_ptr< CallbackStore >	RegisterCompressorOnCallback (NotifyCallback callback, bool initialNotify) override
	Register a callback to be run when the compressor activates.
bool	GetCompressorOn () const override
	Check if the compressor is on.
void	SetCompressorOn (bool compressorOn) override
	Set whether the compressor is active.
std::unique_ptr< CallbackStore >	RegisterClosedLoopEnabledCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run whenever the closed loop state changes.
bool	GetClosedLoopEnabled () const
	Check whether the closed loop compressor control is active.
void	SetClosedLoopEnabled (bool closedLoopEnabled)
	Turn on/off the closed loop control of the compressor.
std::unique_ptr< CallbackStore >	RegisterPressureSwitchCallback (NotifyCallback callback, bool initialNotify) override
	Register a callback to be run whenever the pressure switch value changes.
bool	GetPressureSwitch () const override
	Check the value of the pressure switch.
void	SetPressureSwitch (bool pressureSwitch) override
	Set the value of the pressure switch.
std::unique_ptr< CallbackStore >	RegisterCompressorCurrentCallback (NotifyCallback callback, bool initialNotify) override
	Register a callback to be run whenever the compressor current changes.
double	GetCompressorCurrent () const override
	Read the compressor current.
void	SetCompressorCurrent (double compressorCurrent) override
	Set the compressor current.
uint8_t	GetAllSolenoidOutputs () const override
	Get the current value of all solenoid outputs.
void	SetAllSolenoidOutputs (uint8_t outputs) override
	Change all of the solenoid outputs.
void	ResetData () override
	Reset all simulation data for this object.
Public Member Functions inherited from frc::sim::PneumaticsBaseSim
virtual	~PneumaticsBaseSim ()=default

Additional Inherited Members
Static Public Member Functions inherited from frc::sim::PneumaticsBaseSim
static std::shared_ptr< PneumaticsBaseSim >	GetForType (int module, PneumaticsModuleType type)
Protected Member Functions inherited from frc::sim::PneumaticsBaseSim
	PneumaticsBaseSim (const int index)
	Constructs a PneumaticsBaseSim with the given index.
	PneumaticsBaseSim (const PneumaticsBase &module)
	Constructs a PneumaticsBaseSim for the given module.
Protected Attributes inherited from frc::sim::PneumaticsBaseSim
const int	m_index
	PneumaticsBase index.

Detailed Description

Class to control a simulated Pneumatic Control Module (PCM).

Constructor & Destructor Documentation

CTREPCMSim() [1/3]

frc::sim::CTREPCMSim::CTREPCMSim

(

)

Constructs with the default PCM module number (CAN ID).

CTREPCMSim() [2/3]

frc::sim::CTREPCMSim::CTREPCMSim ( int module )

explicit

Constructs from a PCM module number (CAN ID).

Parameters

module

module number

CTREPCMSim() [3/3]

frc::sim::CTREPCMSim::CTREPCMSim ( const PneumaticsBase & pneumatics )

explicit

~CTREPCMSim()

frc::sim::CTREPCMSim::~CTREPCMSim ( )

overridedefault

Member Function Documentation

GetAllSolenoidOutputs()

uint8_t frc::sim::CTREPCMSim::GetAllSolenoidOutputs ( ) const

overridevirtual

Get the current value of all solenoid outputs.

Returns

the solenoid outputs (1 bit per output)

Implements frc::sim::PneumaticsBaseSim.

GetClosedLoopEnabled()

bool frc::sim::CTREPCMSim::GetClosedLoopEnabled

(

)

const

Check whether the closed loop compressor control is active.

Returns

true if active

GetCompressorCurrent()

double frc::sim::CTREPCMSim::GetCompressorCurrent ( ) const

overridevirtual

Read the compressor current.

Returns

the current of the compressor connected to this module

Implements frc::sim::PneumaticsBaseSim.

GetCompressorOn()

bool frc::sim::CTREPCMSim::GetCompressorOn ( ) const

overridevirtual

Check if the compressor is on.

Returns

true if the compressor is active

Implements frc::sim::PneumaticsBaseSim.

GetInitialized()

bool frc::sim::CTREPCMSim::GetInitialized ( ) const

overridevirtual

Check whether the PCM/PH has been initialized.

Returns

true if initialized

Implements frc::sim::PneumaticsBaseSim.

GetPressureSwitch()

bool frc::sim::CTREPCMSim::GetPressureSwitch ( ) const

overridevirtual

Check the value of the pressure switch.

Returns

the pressure switch value

Implements frc::sim::PneumaticsBaseSim.

GetSolenoidOutput()

bool frc::sim::CTREPCMSim::GetSolenoidOutput ( int channel ) const

overridevirtual

Check the solenoid output on a specific channel.

Parameters

channel

the channel to check

Returns

the solenoid output

Implements frc::sim::PneumaticsBaseSim.

RegisterClosedLoopEnabledCallback()

std::unique_ptr< CallbackStore > frc::sim::CTREPCMSim::RegisterClosedLoopEnabledCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback to be run whenever the closed loop state changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns

the CallbackStore object associated with this callback

RegisterCompressorCurrentCallback()

std::unique_ptr< CallbackStore > frc::sim::CTREPCMSim::RegisterCompressorCurrentCallback ( NotifyCallback callback, bool initialNotify )

nodiscardoverridevirtual

Register a callback to be run whenever the compressor current changes.

Parameters

callback	the callback
initialNotify	whether to call the callback with the initial state

Returns

the CallbackStore object associated with this callback

Implements frc::sim::PneumaticsBaseSim.

RegisterCompressorOnCallback()

std::unique_ptr< CallbackStore > frc::sim::CTREPCMSim::RegisterCompressorOnCallback ( NotifyCallback callback, bool initialNotify )

nodiscardoverridevirtual

Register a callback to be run when the compressor activates.

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.

Implements frc::sim::PneumaticsBaseSim.

RegisterInitializedCallback()

std::unique_ptr< CallbackStore > frc::sim::CTREPCMSim::RegisterInitializedCallback ( NotifyCallback callback, bool initialNotify )

nodiscardoverridevirtual

Register a callback to be run when the PCM/PH is initialized.

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.

Implements frc::sim::PneumaticsBaseSim.

RegisterPressureSwitchCallback()

std::unique_ptr< CallbackStore > frc::sim::CTREPCMSim::RegisterPressureSwitchCallback ( NotifyCallback callback, bool initialNotify )

nodiscardoverridevirtual

Register a callback to be run whenever the pressure switch value changes.

Parameters

callback	the callback
initialNotify	whether the callback should be called with the initial value

Returns

the CallbackStore object associated with this callback

Implements frc::sim::PneumaticsBaseSim.

RegisterSolenoidOutputCallback()

std::unique_ptr< CallbackStore > frc::sim::CTREPCMSim::RegisterSolenoidOutputCallback ( int channel, NotifyCallback callback, bool initialNotify )

nodiscardoverridevirtual

Register a callback to be run when the solenoid output on a channel changes.

Parameters

channel	the channel to monitor
callback	the callback
initialNotify	should the callback be run with the initial value

Returns

the CallbackStore object associated with this callback. Save a reference to this object; it being deconstructed cancels the callback.

Implements frc::sim::PneumaticsBaseSim.

ResetData()

void frc::sim::CTREPCMSim::ResetData ( )

overridevirtual

Reset all simulation data for this object.

Implements frc::sim::PneumaticsBaseSim.

SetAllSolenoidOutputs()

void frc::sim::CTREPCMSim::SetAllSolenoidOutputs ( uint8_t outputs )

overridevirtual

Change all of the solenoid outputs.

Parameters

outputs

the new solenoid outputs (1 bit per output)

Implements frc::sim::PneumaticsBaseSim.

SetClosedLoopEnabled()

void frc::sim::CTREPCMSim::SetClosedLoopEnabled

(

bool

closedLoopEnabled

)

Turn on/off the closed loop control of the compressor.

Parameters

closedLoopEnabled

whether the control loop is active

SetCompressorCurrent()

void frc::sim::CTREPCMSim::SetCompressorCurrent ( double compressorCurrent )

overridevirtual

Set the compressor current.

Parameters

compressorCurrent

the new compressor current

Implements frc::sim::PneumaticsBaseSim.

SetCompressorOn()

void frc::sim::CTREPCMSim::SetCompressorOn ( bool compressorOn )

overridevirtual

Set whether the compressor is active.

Parameters

compressorOn

the new value

Implements frc::sim::PneumaticsBaseSim.

SetInitialized()

void frc::sim::CTREPCMSim::SetInitialized ( bool initialized )

overridevirtual

Define whether the PCM/PH has been initialized.

Parameters

initialized

true for initialized

Implements frc::sim::PneumaticsBaseSim.

SetPressureSwitch()

void frc::sim::CTREPCMSim::SetPressureSwitch ( bool pressureSwitch )

overridevirtual

Set the value of the pressure switch.

Parameters

pressureSwitch

the new value

Implements frc::sim::PneumaticsBaseSim.

SetSolenoidOutput()

void frc::sim::CTREPCMSim::SetSolenoidOutput ( int channel, bool solenoidOutput )

overridevirtual

Change the solenoid output on a specific channel.

Parameters

channel	the channel to check
solenoidOutput	the new solenoid output

Implements frc::sim::PneumaticsBaseSim.

---

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

• frc/simulation/CTREPCMSim.h