Class UserState

Class Documentation

class UserState

Public Functions

UserState() = default
inline UserState(double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8, double v9)
inline bool hasValue(size_t number) const

Does the UserState have the specific value set?

Parameters:

number – The relevant user state value, 1-9.

Returns:

true if the value is set, false otherwise

inline double getValue(size_t number) const

Get the specific UserState value.

Parameters:

number – The relevant user state value, 1-9.

Returns:

The stored value of this entry. Note this may be garbage if not set.

inline void setValue(size_t number, double value)

Set the specific value in the UserState.

Parameters:
  • number – The relevant user state value, 1-9.

  • value – The value to set this user state element to.

inline void clearValue(size_t number)

Clears the specific value set in the UserState.

Parameters:

number – The relevant user state value, 1-9.