frc::sim::PWMSim Class Reference

Class to control a simulated PWM output. More...

#include <frc/simulation/PWMSim.h>

Public Member Functions
	PWMSim (const PWM &pwm)
	Constructs from a PWM object.
	PWMSim (const PWMMotorController &motorctrl)
	Constructs from a PWMMotorController object.
	PWMSim (int channel)
	Constructs from a PWM channel number.
std::unique_ptr< CallbackStore >	RegisterInitializedCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run when the PWM is initialized.
bool	GetInitialized () const
	Check whether the PWM has been initialized.
void	SetInitialized (bool initialized)
	Define whether the PWM has been initialized.
std::unique_ptr< CallbackStore >	RegisterPulseMicrosecondCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run when the PWM pulse microsecond value changes.
int32_t	GetPulseMicrosecond () const
	Get the PWM pulse microsecond value.
void	SetPulseMicrosecond (int32_t microsecondPulseTime)
	Set the PWM pulse microsecond value.
std::unique_ptr< CallbackStore >	RegisterSpeedCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run when the PWM speed changes.
double	GetSpeed () const
	Get the PWM speed.
void	SetSpeed (double speed)
	Set the PWM speed.
std::unique_ptr< CallbackStore >	RegisterPositionCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run when the PWM position changes.
double	GetPosition () const
	Get the PWM position.
void	SetPosition (double position)
	Set the PWM position.
std::unique_ptr< CallbackStore >	RegisterPeriodScaleCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run when the PWM period scale changes.
int	GetPeriodScale () const
	Get the PWM period scale.
void	SetPeriodScale (int periodScale)
	Set the PWM period scale.
std::unique_ptr< CallbackStore >	RegisterZeroLatchCallback (NotifyCallback callback, bool initialNotify)
	Register a callback to be run when the PWM zero latch state changes.
bool	GetZeroLatch () const
	Check whether the PWM is zero latched.
void	SetZeroLatch (bool zeroLatch)
	Define whether the PWM has been zero latched.
void	ResetData ()
	Reset all simulation data.

Detailed Description

Class to control a simulated PWM output.

Constructor & Destructor Documentation

PWMSim() [1/3]

frc::sim::PWMSim::PWMSim ( const PWM & pwm )

explicit

Constructs from a PWM object.

Parameters

pwm	PWM to simulate

PWMSim() [2/3]

frc::sim::PWMSim::PWMSim ( const PWMMotorController & motorctrl )

explicit

Constructs from a PWMMotorController object.

Parameters

motorctrl

PWMMotorController to simulate

PWMSim() [3/3]

frc::sim::PWMSim::PWMSim ( int channel )

explicit

Constructs from a PWM channel number.

Parameters

channel

Channel number

Member Function Documentation

GetInitialized()

bool frc::sim::PWMSim::GetInitialized

(

)

const

Check whether the PWM has been initialized.

Returns

true if initialized

GetPeriodScale()

int frc::sim::PWMSim::GetPeriodScale

(

)

const

Get the PWM period scale.

Returns

the PWM period scale

GetPosition()

double frc::sim::PWMSim::GetPosition

(

)

const

Get the PWM position.

Returns

the PWM position (0.0 to 1.0)

GetPulseMicrosecond()

int32_t frc::sim::PWMSim::GetPulseMicrosecond

(

)

const

Get the PWM pulse microsecond value.

Returns

the PWM pulse microsecond value

GetSpeed()

double frc::sim::PWMSim::GetSpeed

(

)

const

Get the PWM speed.

Returns

the PWM speed (-1.0 to 1.0)

GetZeroLatch()

bool frc::sim::PWMSim::GetZeroLatch

(

)

const

Check whether the PWM is zero latched.

Returns

true if zero latched

RegisterInitializedCallback()

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

nodiscard

Register a callback to be run when the PWM is initialized.

Parameters

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

Returns

the CallbackStore object associated with this callback

RegisterPeriodScaleCallback()

std::unique_ptr< CallbackStore > frc::sim::PWMSim::RegisterPeriodScaleCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback to be run when the PWM period scale changes.

Parameters

callback	the callback
initialNotify	whether to run the callback with the initial value

Returns

the CallbackStore object associated with this callback

RegisterPositionCallback()

std::unique_ptr< CallbackStore > frc::sim::PWMSim::RegisterPositionCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback to be run when the PWM position changes.

Parameters

callback	the callback
initialNotify	whether to run the callback with the initial value

Returns

the CallbackStore object associated with this callback

RegisterPulseMicrosecondCallback()

std::unique_ptr< CallbackStore > frc::sim::PWMSim::RegisterPulseMicrosecondCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback to be run when the PWM pulse microsecond value changes.

Parameters

callback	the callback
initialNotify	whether to run the callback with the initial value

Returns

the CallbackStore object associated with this callback

RegisterSpeedCallback()

std::unique_ptr< CallbackStore > frc::sim::PWMSim::RegisterSpeedCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback to be run when the PWM speed changes.

Parameters

callback	the callback
initialNotify	whether to run the callback with the initial value

Returns

the CallbackStore object associated with this callback

RegisterZeroLatchCallback()

std::unique_ptr< CallbackStore > frc::sim::PWMSim::RegisterZeroLatchCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback to be run when the PWM zero latch state changes.

Parameters

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

Returns

the CallbackStore object associated with this callback

ResetData()

void frc::sim::PWMSim::ResetData

(

)

Reset all simulation data.

SetInitialized()

void frc::sim::PWMSim::SetInitialized

(

bool

initialized

)

Define whether the PWM has been initialized.

Parameters

initialized

whether this object is initialized

SetPeriodScale()

void frc::sim::PWMSim::SetPeriodScale

(

int

periodScale

)

Set the PWM period scale.

Parameters

periodScale

the PWM period scale

SetPosition()

void frc::sim::PWMSim::SetPosition

(

double

position

)

Set the PWM position.

Parameters

position

the PWM position (0.0 to 1.0)

SetPulseMicrosecond()

void frc::sim::PWMSim::SetPulseMicrosecond

(

int32_t

microsecondPulseTime

)

Set the PWM pulse microsecond value.

Parameters

microsecondPulseTime

the PWM pulse microsecond value

SetSpeed()

void frc::sim::PWMSim::SetSpeed

(

double

speed

)

Set the PWM speed.

Parameters

speed

the PWM speed (-1.0 to 1.0)

SetZeroLatch()

void frc::sim::PWMSim::SetZeroLatch

(

bool

zeroLatch

)

Define whether the PWM has been zero latched.

Parameters

zeroLatch

true to indicate zero latched

---

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

• frc/simulation/PWMSim.h