AnalogInInterface Class Reference
[Device Interfaces]

#include <rtt/dev/AnalogInInterface.hpp>

Inheritance diagram for AnalogInInterface:

Detailed Description

An interface for reading analog input, like for addressing a whole subdevice in comedi.

Unit (MU) : Unit of what is actually read on the analog channel (e.g. Volt)

Definition at line 66 of file AnalogInInterface.hpp.


Public Types
enum	AnalogReference { Ground = 0, Common, Differential, Other }
	This enum can be used to configure the arefSet() function. More...
Public Member Functions
	AnalogInInterface ()
	Create a not nameserved AnalogInInterface instance.
	AnalogInInterface (const std::string &name)
	Create a nameserved AnalogInInterface.
virtual void	rangeSet (unsigned int chan, unsigned int range)=0
	Set the range of a particular channel.
virtual void	arefSet (unsigned int chan, unsigned int aref)=0
	Set the analog reference of a particular channel.
virtual int	rawRead (unsigned int chan, int &value)=0
	Read a raw value from channel chan.
virtual int	read (unsigned int chan, double &value)=0
	Read the real value from channel chan.
virtual unsigned int	rawRange () const =0
	Returns the absolute maximal range (e.g.
virtual double	lowest (unsigned int chan) const =0
	Returns the current lowest measurable input expressed in MU's for a given channel.
virtual double	highest (unsigned int chan) const =0
	Returns the highest measurable input expressed in MU's for a given channel.
virtual double	resolution (unsigned int chan) const =0
	Resolution is expressed in bits / MU.
virtual unsigned int	nbOfChannels () const =0
	Returns the total number of channels.
unsigned int	binaryRange () const
	Returns the binary range (e.g.
int	binaryLowest () const
	Returns the binary lowest value.
int	binaryHighest () const
	Returns the binary highest value.
Static Public Attributes
static NameServer < AnalogInInterface * >	nameserver
	The NameServer for this interface.

Member Enumeration Documentation

enum AnalogReference

This enum can be used to configure the arefSet() function.

See also:: http://www.comedi.org

Enumerator:

Common	Reference to ground.
Differential	Common reference.
Other	Differential reference. Undefined

Definition at line 74 of file AnalogInInterface.hpp.

Constructor & Destructor Documentation

AnalogInInterface ( const std::string & name ) [inline]

Create a nameserved AnalogInInterface.

When name is not "" and unique, it can be retrieved using the AnalogOutInterface::nameserver.

Definition at line 90 of file AnalogInInterface.hpp.

Member Function Documentation

virtual void rangeSet	(	unsigned int	chan,
		unsigned int	range
	)			`[pure virtual]`

Set the range of a particular channel.

We took (for now) the comedi API for this, where every range (eg. -5/+5 V) corresponds to an unsigned int. You should provide a mapping from that int to a particular range in your driver documentation