wpi::hal::SimDouble Class Reference

C++ wrapper around a HAL simulator double value handle. More...

#include <wpi/hal/SimDevice.hpp>

Inheritance diagram for wpi::hal::SimDouble:

Public Member Functions
	SimDouble ()=default
	Default constructor that results in an "empty" object that is false in a boolean context.
	SimDouble (HAL_SimValueHandle val)
	Wraps a simulated value handle as returned by HAL_CreateSimValueDouble().
double	Get () const
	Gets the simulated value.
void	Set (double value)
	Sets the simulated value.
void	Reset ()
	Resets the simulated value to 0.
Public Member Functions inherited from wpi::hal::SimValue
	SimValue ()=default
	Default constructor that results in an "empty" object that is false in a boolean context.
	SimValue (HAL_SimValueHandle val)
	Wraps a simulated value handle as returned by HAL_CreateSimValue().
	operator bool () const
	Determine if handle is empty.
	operator HAL_SimValueHandle () const
	Get the internal device handle.
HAL_Value	GetValue () const
	Gets the simulated value.
void	SetValue (const HAL_Value &value)
	Sets the simulated value.

Additional Inherited Members
Protected Attributes inherited from wpi::hal::SimValue
HAL_SimValueHandle	m_handle = HAL_kInvalidHandle

Detailed Description

C++ wrapper around a HAL simulator double value handle.

Constructor & Destructor Documentation

SimDouble() [1/2]

wpi::hal::SimDouble::SimDouble ( )

default

Default constructor that results in an "empty" object that is false in a boolean context.

SimDouble() [2/2]

wpi::hal::SimDouble::SimDouble ( HAL_SimValueHandle val )

inline

Wraps a simulated value handle as returned by HAL_CreateSimValueDouble().

Parameters

val	simulated value handle

Member Function Documentation

Get()

double wpi::hal::SimDouble::Get ( ) const

inline

Gets the simulated value.

Returns

The current value

Reset()

void wpi::hal::SimDouble::Reset ( )

inline

Resets the simulated value to 0.

Use this instead of Set(0) for resetting incremental sensor values like encoder counts or gyro accumulated angle to ensure correct behavior in a distributed system (e.g. WebSockets).

Set()

void wpi::hal::SimDouble::Set ( double value )

inline

Sets the simulated value.

Parameters

value

the value to set

---

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

• wpi/hal/SimDevice.hpp