hebi::UserState Class Reference

#include <group.hpp>

Public Member Functions
	UserState ()=default
	UserState (double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8, double v9)
bool	hasValue (size_t number) const
	Does the UserState have the specific value set? More...
double	getValue (size_t number) const
	Get the specific UserState value. More...
void	setValue (size_t number, double value)
	Set the specific value in the UserState. More...
void	clearValue (size_t number)
	Clears the specific value set in the UserState. More...

Friends
class	Group

Constructor & Destructor Documentation

UserState() [1/2]

hebi::UserState::UserState ( )

default

UserState() [2/2]

hebi::UserState::UserState ( double  v1, double  v2, double  v3, double  v4, double  v5, double  v6, double  v7, double  v8, double  v9  )

inline

Member Function Documentation

hasValue()

bool hebi::UserState::hasValue ( size_t  number ) const

inline

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

getValue()

double hebi::UserState::getValue ( size_t  number ) const

inline

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.

setValue()

void hebi::UserState::setValue ( size_t  number, double  value  )

inline

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.

clearValue()

void hebi::UserState::clearValue ( size_t  number )

inline

Clears the specific value set in the UserState.

Parameters

number

The relevant user state value, 1-9.

Friends And Related Function Documentation

Group

friend class Group

friend

---

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

• group.hpp