wpi::hal::SimEnum Class Reference

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

#include <wpi/hal/SimDevice.hpp>

Inheritance diagram for wpi::hal::SimEnum:

Public Member Functions
	SimEnum ()=default
	Default constructor that results in an "empty" object that is false in a boolean context.
	SimEnum (HAL_SimValueHandle val)
	Wraps a simulated value handle as returned by HAL_CreateSimValueEnum().
int32_t	Get () const
	Gets the simulated value.
void	Set (int32_t value)
	Sets the simulated value.
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 enum value handle.

Constructor & Destructor Documentation

SimEnum() [1/2]

wpi::hal::SimEnum::SimEnum ( )

default

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

SimEnum() [2/2]

wpi::hal::SimEnum::SimEnum ( HAL_SimValueHandle val )

inline

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

Parameters

val	simulated value handle

Member Function Documentation

Get()

int32_t wpi::hal::SimEnum::Get ( ) const

inline

Gets the simulated value.

Returns

The current value

Set()

void wpi::hal::SimEnum::Set ( int32_t 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