hal::SimDevice Class Reference

A move-only C++ wrapper around a HAL simulator device handle. More...

#include <hal/SimDevice.h>

Public Types
enum	Direction { kInput = HAL_SimValueInput , kOutput = HAL_SimValueOutput , kBidir = HAL_SimValueBidir }
	Direction of a simulated value (from the perspective of user code). More...

Public Member Functions
	SimDevice ()=default
	Default constructor that results in an "empty" object that is false in a boolean context.
	SimDevice (const char *name)
	Creates a simulated device.
	SimDevice (const char *name, int index)
	Creates a simulated device.
	SimDevice (const char *name, int index, int channel)
	Creates a simulated device.
	~SimDevice ()
	SimDevice (const SimDevice &)=delete
SimDevice &	operator= (const SimDevice &)=delete
	SimDevice (SimDevice &&rhs)
SimDevice &	operator= (SimDevice &&rhs)
	operator bool () const
	Determine if handle is empty.
	operator HAL_SimDeviceHandle () const
	Get the internal device handle.
std::string	GetName () const
	Get the name of the simulated device.
SimValue	CreateValue (const char *name, int32_t direction, const HAL_Value &initialValue)
	Creates a value on the simulated device.
SimInt	CreateInt (const char *name, int32_t direction, int32_t initialValue)
	Creates an int value on the simulated device.
SimLong	CreateLong (const char *name, int32_t direction, int64_t initialValue)
	Creates a long value on the simulated device.
SimDouble	CreateDouble (const char *name, int32_t direction, double initialValue)
	Creates a double value on the simulated device.
SimEnum	CreateEnum (const char *name, int32_t direction, std::initializer_list< const char * > options, int32_t initialValue)
	Creates an enumerated value on the simulated device.
SimEnum	CreateEnum (const char *name, int32_t direction, std::span< const char *const > options, int32_t initialValue)
	Creates an enumerated value on the simulated device.
SimEnum	CreateEnumDouble (const char *name, int32_t direction, std::initializer_list< const char * > options, std::initializer_list< double > optionValues, int32_t initialValue)
	Creates an enumerated value on the simulated device with double values.
SimEnum	CreateEnumDouble (const char *name, int32_t direction, std::span< const char *const > options, std::span< const double > optionValues, int32_t initialValue)
	Creates an enumerated value on the simulated device with double values.
SimBoolean	CreateBoolean (const char *name, int32_t direction, bool initialValue)
	Creates a boolean value on the simulated device.

Protected Attributes
HAL_SimDeviceHandle	m_handle = HAL_kInvalidHandle

Detailed Description

A move-only C++ wrapper around a HAL simulator device handle.

Member Enumeration Documentation

Direction

enum hal::SimDevice::Direction

Direction of a simulated value (from the perspective of user code).

Enumerator
kInput
kOutput
kBidir

Constructor & Destructor Documentation

SimDevice() [1/6]

hal::SimDevice::SimDevice ( )

default

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

SimDevice() [2/6]

hal::SimDevice::SimDevice ( const char * name )

inlineexplicit

Creates a simulated device.

The device name must be unique. Returns null if the device name already exists. If multiple instances of the same device are desired, recommend appending the instance/unique identifier in brackets to the base name, e.g. "device[1]".

Using a device name of the form "Type:Name" will create a WebSockets node with a type value of "Type" and a device value of "Name"

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	device name

SimDevice() [3/6]

hal::SimDevice::SimDevice	(	const char *	name,
		int	index )

Creates a simulated device.

The device name must be unique. Returns null if the device name already exists. This is a convenience method that appends index in brackets to the device name, e.g. passing index=1 results in "device[1]" for the device name.

Using a device name of the form "Type:Name" will create a WebSockets node with a type value of "Type" and a device value of "Name"

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	device name
index	device index number to append to name

SimDevice() [4/6]

hal::SimDevice::SimDevice	(	const char *	name,
		int	index,
		int	channel )

Creates a simulated device.

The device name must be unique. Returns null if the device name already exists. This is a convenience method that appends index and channel in brackets to the device name, e.g. passing index=1 and channel=2 results in "device[1,2]" for the device name.

Using a device name of the form "Type:Name" will create a WebSockets node with a type value of "Type" and a device value of "Name"

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	device name
index	device index number to append to name
channel	device channel number to append to name

~SimDevice()

hal::SimDevice::~SimDevice ( )

inline

SimDevice() [5/6]

hal::SimDevice::SimDevice ( const SimDevice & )

delete

SimDevice() [6/6]

hal::SimDevice::SimDevice ( SimDevice && rhs )

inline

Member Function Documentation

CreateBoolean()

SimBoolean hal::SimDevice::CreateBoolean ( const char * name, int32_t direction, bool initialValue )

inline

Creates a boolean value on the simulated device.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
initialValue	initial value

Returns

simulated boolean value object

CreateDouble()

SimDouble hal::SimDevice::CreateDouble ( const char * name, int32_t direction, double initialValue )

inline

Creates a double value on the simulated device.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
initialValue	initial value

Returns

simulated double value object

CreateEnum() [1/2]

SimEnum hal::SimDevice::CreateEnum ( const char * name, int32_t direction, std::initializer_list< const char * > options, int32_t initialValue )

inline

Creates an enumerated value on the simulated device.

Enumerated values are always in the range 0 to numOptions-1.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
options	array of option descriptions
initialValue	initial value (selection)

Returns

simulated enum value object

CreateEnum() [2/2]

SimEnum hal::SimDevice::CreateEnum ( const char * name, int32_t direction, std::span< const char *const > options, int32_t initialValue )

inline

Creates an enumerated value on the simulated device.

Enumerated values are always in the range 0 to numOptions-1.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
options	array of option descriptions
initialValue	initial value (selection)

Returns

simulated enum value object

CreateEnumDouble() [1/2]

SimEnum hal::SimDevice::CreateEnumDouble ( const char * name, int32_t direction, std::initializer_list< const char * > options, std::initializer_list< double > optionValues, int32_t initialValue )

inline

Creates an enumerated value on the simulated device with double values.

Enumerated values are always in the range 0 to numOptions-1.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
options	array of option descriptions
optionValues	array of option values (must be the same size as options)
initialValue	initial value (selection)

Returns

simulated enum value object

CreateEnumDouble() [2/2]

SimEnum hal::SimDevice::CreateEnumDouble ( const char * name, int32_t direction, std::span< const char *const > options, std::span< const double > optionValues, int32_t initialValue )

inline

Creates an enumerated value on the simulated device with double values.

Enumerated values are always in the range 0 to numOptions-1.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
options	array of option descriptions
optionValues	array of option values (must be the same size as options)
initialValue	initial value (selection)

Returns

simulated enum value object

CreateInt()

SimInt hal::SimDevice::CreateInt ( const char * name, int32_t direction, int32_t initialValue )

inline

Creates an int value on the simulated device.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
initialValue	initial value

Returns

simulated double value object

CreateLong()

SimLong hal::SimDevice::CreateLong ( const char * name, int32_t direction, int64_t initialValue )

inline

Creates a long value on the simulated device.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
initialValue	initial value

Returns

simulated double value object

CreateValue()

SimValue hal::SimDevice::CreateValue ( const char * name, int32_t direction, const HAL_Value & initialValue )

inline

Creates a value on the simulated device.

If not in simulation, results in an "empty" object that evaluates to false in a boolean context.

Parameters

name	value name
direction	input/output/bidir (from perspective of user code)
initialValue	initial value

Returns

simulated value object

GetName()

std::string hal::SimDevice::GetName ( ) const

inline

Get the name of the simulated device.

Returns

name

operator bool()

hal::SimDevice::operator bool ( ) const

inlineexplicit

Determine if handle is empty.

Should be used to optimize out code paths that are taken/not taken in simulation.

Returns

False if handle is empty, true if handle is valid.

operator HAL_SimDeviceHandle()

hal::SimDevice::operator HAL_SimDeviceHandle ( ) const

inline

Get the internal device handle.

Returns

internal handle

operator=() [1/2]

SimDevice & hal::SimDevice::operator= ( const SimDevice & )

delete

operator=() [2/2]

SimDevice & hal::SimDevice::operator= ( SimDevice && rhs )

inline

Member Data Documentation

m_handle

HAL_SimDeviceHandle hal::SimDevice::m_handle = HAL_kInvalidHandle

protected

---

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

• hal/SimDevice.h