urcl::Limited< T > Class Template Reference

Helper class that represents a numeric value with a lower and an upper boundary. More...

#include <tool_communication.h>

Public Types
using	Datatype = T

Public Member Functions
T	getData () const
	Returns the data stored in this object. More...
	Limited ()=delete
	Limited (const T lower, const T upper)
	Create a new Limited object. More...
void	setData (const T data)
	Set the data field with a given value. More...
	~Limited ()=default

Private Attributes
T	data_
const T	lower_
const T	upper_

Detailed Description

template<class T>
class urcl::Limited< T >

Helper class that represents a numeric value with a lower and an upper boundary.

Template Parameters

T	any type for which a comparison exists.

Definition at line 64 of file tool_communication.h.

Member Typedef Documentation

Datatype

template<class T >

using urcl::Limited< T >::Datatype = T

Definition at line 70 of file tool_communication.h.

Constructor & Destructor Documentation

Limited() [1/2]

template<class T >

urcl::Limited< T >::Limited ( )

delete

~Limited()

template<class T >

urcl::Limited< T >::~Limited ( )

default

Limited() [2/2]

template<class T >

urcl::Limited< T >::Limited ( const T  lower, const T  upper  )

inline

Create a new Limited object.

Parameters

lower	Lower boundary used for this Limited object
upper	Upper boundary used for this Limited object

Definition at line 78 of file tool_communication.h.

Member Function Documentation

getData()

template<class T >

T urcl::Limited< T >::getData ( ) const

inline

Returns the data stored in this object.

Definition at line 105 of file tool_communication.h.

setData()

template<class T >

void urcl::Limited< T >::setData ( const T  data )

inline

Set the data field with a given value.

If the given value is out of the configured range, an exception is thrown.

Parameters

data

Definition at line 90 of file tool_communication.h.

Member Data Documentation

data_

template<class T >

T urcl::Limited< T >::data_

private

Definition at line 111 of file tool_communication.h.

lower_

template<class T >

const T urcl::Limited< T >::lower_

private

Definition at line 112 of file tool_communication.h.

upper_

template<class T >

const T urcl::Limited< T >::upper_

private

Definition at line 113 of file tool_communication.h.

---

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

• tool_communication.h