rec::robotino::api2::AnalogInputArray Class Reference

An analog Input. More...

#include <AnalogInputArray.h>

Inheritance diagram for rec::robotino::api2::AnalogInputArray:

Public Member Functions
void	setComId (const ComId &id)
void	processEvents ()
void	values (float *readings) const
virtual void	valuesChangedEvent (const float *values, unsigned int size)
Public Member Functions inherited from rec::robotino::api2::ComObject
	ComObject ()
virtual	~ComObject ()
ComId	comId () const

Static Public Member Functions
static unsigned int	numAnalogInputs ()

Friends
class	AnalogInputArrayImpl

Additional Inherited Members
Protected Attributes inherited from rec::robotino::api2::ComObject
ComId	_comID

Detailed Description

An analog Input.

Member Function Documentation

static unsigned int rec::robotino::api2::AnalogInputArray::numAnalogInputs ( )

static

Returns

Returns the number of analog inputs.

void rec::robotino::api2::AnalogInputArray::processEvents

(

)

Call this function from your main thread to get the virtual AnalogInput functions called. The virtual functions are called directly by a call of this function

Exceptions

nothing

See also

Com::processEvents

void rec::robotino::api2::AnalogInputArray::setComId

(

const ComId &

id

)

Sets the associated communication object.

Parameters

id	The id of the associated communication object.

Exceptions

RobotinoException

if given id is invalid.

Remarks

This function is thread save

void rec::robotino::api2::AnalogInputArray::values

(

float *

readings

)

const

Returns the current values of all analog inputs.

Parameters

[out]

readings

The current readings of all analog inputs

Exceptions

Exception

if the underlying communication object is invalid

See also

ComObject::setComId

virtual void rec::robotino::api2::AnalogInputArray::valuesChangedEvent ( const float *  values, unsigned int  size  )

virtual

Called when new readings are available.

Parameters

values	The state of all analog inputs
size	The number of elements in values

Remarks

This function is called from the thread in which Com::processEvents() is called.

See also

Com::processEvents

---

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

• C:/srcs/git/openrobotino/api2/lib/rec/robotino/api2/AnalogInputArray.h