Public Member Functions

CQEAnalog Class Reference

CQEAnalog allows you to read the analog voltage channels. More...

#include <qeanalog.h>

Inheritance diagram for CQEAnalog:
IProperty

List of all members.

Public Member Functions

 SINGLETON (CQEAnalog)
 This internal macro handles instantiation of this class.
unsigned short GetADRaw (unsigned int channel)
 Read the raw analog-to-digital channel value.
unsigned short GetADVoltage (unsigned int channel)
 Read the analog-to-digital channel voltage.
virtual int GetProperty (int property, long *value)
 Get the property value.
virtual int SetProperty (int property, long value)
 Set the property value.

Detailed Description

CQEAnalog allows you to read the analog voltage channels.

For now this class is input-only (read-only). To instantiate this class: 

 // by pointer
 CQEAnalog *panalog = CQEAnalog::GetPtr(); 
 // or by reference
 CQEAnalog &analog = CQEAnalog::GetRef();

And when done with this class, call Release(), for each call to GetPtr() or GetRef(): 

 CQEAnalog::Release();

Member Function Documentation

unsigned short CQEAnalog::GetADRaw ( unsigned int  channel  ) 

Read the raw analog-to-digital channel value.

It is recommended that you call GetADVoltage() instead. The channels are typically low bandwidth -- no greater than 1 kHz.

Parameters:
channel the analog channel number (0 through 24 for VEXPro ARM9)
Returns:
the raw a/d channel value. This value is proportional to the actual voltage.
unsigned short CQEAnalog::GetADVoltage ( unsigned int  channel  ) 

Read the analog-to-digital channel voltage.

The channels are typically low bandwidth -- no greater than 1 kHz.

Parameters:
channel the analog channel number (0 through 24 for VEXPro ARM9)
Returns:
the a/d channel voltage in millivolts. For VexPRO ARM 9, these channels are:
  • 0=External analog channel 1 (via 3-pin connector banks)
  • 1=External analog channel 2
  • 2=External analog channel 3
  • 3=External analog channel 4
  • 4=External analog channel 5
  • 5=External analog channel 6
  • 6=External analog channel 7
  • 7=External analog channel 8
  • 8=External analog channel 9
  • 9=External analog channel 10
  • 10=External analog channel 11
  • 11=External analog channel 12
  • 12=External analog channel 13
  • 13=External analog channel 14
  • 14=External analog channel 15
  • 15=External analog channel 16
  • 16=PSD protected voltage for motors 1 through 4
  • 17=PSD protected voltage for motors 5 through 8
  • 18=PSD protected voltage for motors 9 through 12
  • 19=PSD protected voltage for motors 13 and 14
  • 20=PSD protected voltage for motors 15 and 16
  • 21=Battery backup voltage
  • 22=Regulator voltage for analog and digital I/O connectors (5V)
  • 23=Regulator voltage for VEXPro internal electronics (5V)
  • 24=Main battery voltage
int CQEAnalog::GetProperty ( int  property,
long *  value 
) [virtual]

Get the property value.

Parameters:
property the numerical identifier of the property
value the value of the property is written into this long pointer
Returns:
  • PROP_OK=success (0)
  • PROP_ERROR=general error (-1)
  • PROP_ERROR_NOT_SUPPORTED=property doesn't exist or isn't supported (-2)

Implements IProperty.

int CQEAnalog::SetProperty ( int  property,
long  value 
) [virtual]

Set the property value.

Parameters:
property the numerical identifier of the property
value the value of the property
Returns:
  • PROP_OK=success (0)
  • PROP_ERROR=general error (-1)
  • PROP_ERROR_NOT_SUPPORTED=property doesn't exist or isn't supported (-2)
  • PROP_ERROR_READ_ONLY=property can only be read (-3)
  • PROP_ERROR_ILLEGAL_VALUE=the value is not permitted (-4)

Implements IProperty.

CQEAnalog::SINGLETON ( CQEAnalog   ) 

This internal macro handles instantiation of this class.

The documentation for this class was generated from the following files:
Generated on Mon Oct 3 2011 15:36:31 for libqwerk by  doxygen 1.7.1