AnalogInInterface Class Template Reference
[Device Interfaces]

#include <rtt/dev/AnalogInInterface.hpp>

Inheritance diagram for AnalogInInterface:

List of all members.

---

Detailed Description

template<class T>
class RTT::AnalogInInterface< T >

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 67 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	~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 void	read (unsigned int chan, T &value) const =0
	Read value from channel chan.
virtual T	binaryRange () const =0
	Returns the binary range (e.g.
virtual T	binaryLowest () const =0
	Returns the binary lowest value.
virtual T	binaryHighest () const =0
	Returns the binary highest value.
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.
Static Public Attributes
static NameServer < AnalogInInterface < T > * >	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:

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

Definition at line 75 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 91 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

virtual void arefSet	(	unsigned int	chan,
		unsigned int	aref
	)			[pure virtual]

Set the analog reference of a particular channel.

We took (for now) the comedi API for this, where every aref (eg. Analog reference set to ground (aka AREF_GROUND) corresponds to an unsigned int.

See also:

AnalogReference

virtual T binaryRange

(

)

const [pure virtual]

Returns the binary range (e.g.

12bits AD -> 4096)

---

Member Data Documentation

NameServer< AnalogInInterface< T > * > nameserver [inline, static]

The NameServer for this interface.

See also:

NameServer

Definition at line 163 of file AnalogInInterface.hpp.

---

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

• rtt/dev/AnalogInInterface.hpp

---