frc::sim::AddressableLEDSim Class Reference

Class to control a simulated addressable LED. More...

#include <frc/simulation/AddressableLEDSim.h>

Public Member Functions
	AddressableLEDSim ()
	Constructs for the first addressable LED.
	AddressableLEDSim (const AddressableLED &addressableLED)
	Constructs from an AddressableLED object.
std::unique_ptr< CallbackStore >	RegisterInitializedCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on the Initialized property.
bool	GetInitialized () const
	Check if initialized.
void	SetInitialized (bool initialized)
	Change the Initialized value of the LED strip.
std::unique_ptr< CallbackStore >	RegisterOutputPortCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on the output port.
int	GetOutputPort () const
	Get the output port.
void	SetOutputPort (int outputPort)
	Change the output port.
std::unique_ptr< CallbackStore >	RegisterLengthCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on the length.
int	GetLength () const
	Get the length of the LED strip.
void	SetLength (int length)
	Change the length of the LED strip.
std::unique_ptr< CallbackStore >	RegisterRunningCallback (NotifyCallback callback, bool initialNotify)
	Register a callback on whether the LEDs are running.
int	GetRunning () const
	Check if the LEDs are running.
void	SetRunning (bool running)
	Change whether the LEDs are active.
std::unique_ptr< CallbackStore >	RegisterDataCallback (ConstBufferCallback callback, bool initialNotify)
	Register a callback on the LED data.
int	GetData (struct HAL_AddressableLEDData *data) const
	Get the LED data.
void	SetData (struct HAL_AddressableLEDData *data, int length)
	Change the LED data.

Static Public Member Functions
static AddressableLEDSim	CreateForChannel (int pwmChannel)
	Creates an AddressableLEDSim for a PWM channel.
static AddressableLEDSim	CreateForIndex (int index)
	Creates an AddressableLEDSim for a simulated index.

Detailed Description

Class to control a simulated addressable LED.

Constructor & Destructor Documentation

AddressableLEDSim() [1/2]

frc::sim::AddressableLEDSim::AddressableLEDSim

(

)

Constructs for the first addressable LED.

AddressableLEDSim() [2/2]

frc::sim::AddressableLEDSim::AddressableLEDSim ( const AddressableLED & addressableLED )

explicit

Constructs from an AddressableLED object.

Parameters

addressableLED

AddressableLED to simulate

Member Function Documentation

CreateForChannel()

static AddressableLEDSim frc::sim::AddressableLEDSim::CreateForChannel ( int pwmChannel )

static

Creates an AddressableLEDSim for a PWM channel.

Parameters

pwmChannel

PWM channel

Returns

Simulated object

Throws:

std::out_of_range if no AddressableLED is configured for that channel

CreateForIndex()

static AddressableLEDSim frc::sim::AddressableLEDSim::CreateForIndex ( int index )

static

Creates an AddressableLEDSim for a simulated index.

The index is incremented for each simulated AddressableLED.

Parameters

index

simulator index

Returns

Simulated object

GetData()

int frc::sim::AddressableLEDSim::GetData

(

struct HAL_AddressableLEDData *

data

)

const

Get the LED data.

Parameters

data	output parameter to fill with LED data

Returns

the length of the LED data

GetInitialized()

bool frc::sim::AddressableLEDSim::GetInitialized

(

)

const

Check if initialized.

Returns

true if initialized

GetLength()

int frc::sim::AddressableLEDSim::GetLength

(

)

const

Get the length of the LED strip.

Returns

the length

GetOutputPort()

int frc::sim::AddressableLEDSim::GetOutputPort

(

)

const

Get the output port.

Returns

the output port

GetRunning()

int frc::sim::AddressableLEDSim::GetRunning

(

)

const

Check if the LEDs are running.

Returns

true if they are

RegisterDataCallback()

std::unique_ptr< CallbackStore > frc::sim::AddressableLEDSim::RegisterDataCallback ( ConstBufferCallback callback, bool initialNotify )

nodiscard

Register a callback on the LED data.

Parameters

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

Returns

the CallbackStore object associated with this callback

RegisterInitializedCallback()

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

nodiscard

Register a callback on the Initialized property.

Parameters

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

Returns

the CallbackStore object storing this callback

RegisterLengthCallback()

std::unique_ptr< CallbackStore > frc::sim::AddressableLEDSim::RegisterLengthCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback on the length.

Parameters

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

Returns

the CallbackStore object associated with this callback

RegisterOutputPortCallback()

std::unique_ptr< CallbackStore > frc::sim::AddressableLEDSim::RegisterOutputPortCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback on the output port.

Parameters

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

Returns

the CallbackStore object associated with this callback

RegisterRunningCallback()

std::unique_ptr< CallbackStore > frc::sim::AddressableLEDSim::RegisterRunningCallback ( NotifyCallback callback, bool initialNotify )

nodiscard

Register a callback on whether the LEDs are running.

Parameters

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

Returns

the CallbackStore object associated with this callback

SetData()

void frc::sim::AddressableLEDSim::SetData	(	struct HAL_AddressableLEDData *	data,
		int	length )

Change the LED data.

Parameters

data	the new data
length	the length of the LED data

SetInitialized()

void frc::sim::AddressableLEDSim::SetInitialized

(

bool

initialized

)

Change the Initialized value of the LED strip.

Parameters

initialized

the new value

SetLength()

void frc::sim::AddressableLEDSim::SetLength

(

int

length

)

Change the length of the LED strip.

Parameters

length

the new value

SetOutputPort()

void frc::sim::AddressableLEDSim::SetOutputPort

(

int

outputPort

)

Change the output port.

Parameters

outputPort

the new output port

SetRunning()

void frc::sim::AddressableLEDSim::SetRunning

(

bool

running

)

Change whether the LEDs are active.

Parameters

running

the new value

---

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

• frc/simulation/AddressableLEDSim.h