Represents a common ADC module. More...

Public Member Functions
double	GetAdc (int channel)
	Get the value of the ADC. More...

int	GetAdcRaw (int channel)
	Get the raw value of the ADC. More...

abstract int	GetNumChannels ()
	Get number of channels of the ADC. More...

abstract PhysicalValue	GetRangeMax (int channel)
	Get the maximum value of a channel. More...

bool	IsCanBridge ()
	Check if this node acts as a CAN bridge (it is connected directly to PC). More...

int	GetStatusRegister ()
	Get the value of the status register. More...

int	GetRegisterI (RegisterNumber reg)
	Get regular (integral) MATES register. More...

float	GetRegisterF (RegisterNumber reg)
	Get floating point MATES register. More...

void	SetRegisterI (RegisterNumber reg, int val)
	Set regular (integral) MATES register. More...

void	SetRegisterF (RegisterNumber reg, float val)
	Set floating point MATES register. More...

void	RegisterEquals (RegisterNumber register, int value)
	Asserts that the specified integral register has the specified value. More...

void	RegisterEquals (RegisterNumber register, float value)
	Asserts that the specified floating point register has the specified value. More...

void	LampTest ()
	Execute lamp test. More...

string	NodeInfo ()
	Get node information as string. More...

Data Fields
RegList	Registers
	The registers that are associated with this node. Populated by the node constructor. More...

Properties
int	SerialNumber `[get]`
	Holds the device serial number. More...

string	NodeIdName `[get]`
	Get string representation of this node Id (NodeId). More...

string	NodeName `[get]`
	Get node name of this node. More...

Detailed Description

Represents a common ADC module.

Member Function Documentation

double GetAdc ( int channel )

Get the value of the ADC.

Parameters

channel The ADC channel number [0,39].

Returns: ADC voltage value in Volts.

Example usage (mates_test_01.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;
namespace unit_tests
{
   [TestClass]
   public class mates_test_01
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Adc5Node node = mates.NewAdc5Node(NodeId.mates_adc5_mk1_1);
               Console.Write("Voltage at channel IN01: {0} V\n", node.GetAdc(0));
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

Implements IAdcNode.

int GetAdcRaw ( int channel )

Get the raw value of the ADC.

Parameters

channel The ADC channel number [0,39]

Returns: The raw ADC value.

Example usage (mates_test_02.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;
namespace unit_tests
{
   [TestClass]
   public class mates_test_02
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Adc5Node node = mates.NewAdc5Node(NodeId.mates_adc5_mk1_1);
               int val = node.GetAdcRaw(0);
               Console.Write("Raw value at channel IN01: {0} V\n", val);
               Assert.IsTrue(val >= 0 && val <= 65535);
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

Implements IAdcNode.

abstract int GetNumChannels ( )

pure virtual

Get number of channels of the ADC.

Returns: The number of channels.

Implements IAdcNode.

Implemented in Adc5Node.

abstract PhysicalValue GetRangeMax ( int channel )

pure virtual

Get the maximum value of a channel.

Parameters

channel

Returns: The maximum value in Volts, Amperes or Degrees Centigrade.

Implements IAdcNode.

Implemented in Adc5Node.

bool IsCanBridge ( )

inherited

Check if this node acts as a CAN bridge (it is connected directly to PC).

Returns: True if CAN bridge, otherwise false.

int GetStatusRegister ( )

inherited

Get the value of the status register.

Returns: The REG_COMMON_SR register value.

int GetRegisterI ( RegisterNumber reg )

inherited

Get regular (integral) MATES register.

Parameters

reg	The register number to access (see Viresco.Mates.Registers.RegisterNumber).

Returns: The register value.

float GetRegisterF ( RegisterNumber reg )

inherited

Get floating point MATES register.

Parameters

reg	The register number to access (see Viresco.Mates.Registers.RegisterNumber).

Returns: The register value.

void SetRegisterI	(	RegisterNumber	reg,
		int	val
	)

inherited

Set regular (integral) MATES register.

Parameters

reg	The register number to access (see Viresco.Mates.Registers.RegisterNumber).
val	The register value.

void SetRegisterF	(	RegisterNumber	reg,
		float	val
	)

inherited

Set floating point MATES register.

Parameters

reg	The register number to access (see Viresco.Mates.Registers.RegisterNumber).
val	The register value.

void RegisterEquals	(	RegisterNumber	register,
		int	value
	)

inherited

Asserts that the specified integral register has the specified value.

Parameters

register	The register number.
value	The expected value.

Implements INodeAsserts.

void RegisterEquals	(	RegisterNumber	register,
		float	value
	)

inherited

Asserts that the specified floating point register has the specified value.

Parameters

register	The register number.
value	The expected value.

Implements INodeAsserts.

void LampTest ( )

inherited

Execute lamp test.

Example usage (mates_test_11.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;
namespace unit_tests
{
   [TestClass]
   public class mates_test_11
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Dio3Node dio = mates.NewDio3Node(NodeId.mates_dio3_mk1_1);
               // Locate node by blinking its LEDs.
               dio.LampTest();
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

string NodeInfo ( )

inherited

Get node information as string.

Returns: The node information.

Example usage (mates_test_13.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;
namespace unit_tests
{
   [TestClass]
   public class mates_test_13
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               UccNode dio = mates.NewUccNode(NodeId.mates_ucc_mk1_1);
               // Get node info and print to console.
               string info = dio.NodeInfo();
               Console.Write(info);
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

Field Documentation

RegList Registers

inherited

The registers that are associated with this node. Populated by the node constructor.

Property Documentation

int SerialNumber

getinherited

Holds the device serial number.

string NodeIdName

getinherited

Get string representation of this node Id (NodeId).

string NodeName

getinherited

Get node name of this node.

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

Adc5Node.cs

Public Member Functions

Data Fields

Properties

Detailed Description

Member Function Documentation

Field Documentation

Property Documentation