DioNode Class Reference

Represents a common digital IO module. More...

Public Member Functions
void	SetDout (int channel, bool value)
	Set value of an individual digital output. More...
void	SetDoutAll (int value)
	Set value of all digital outputs. More...
bool	GetDout (int channel)
	Get value of an individual digital output. More...
int	GetDoutAll ()
	Get value of all digital outputs. More...
bool	GetDin (int channel)
	Get value of an individual digital input. More...
int	GetDinAll ()
	Get value of all digital inputs. 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...

Protected Member Functions
void	InputSet (int channel)
	Asserts that the specified input channel is in high state. More...
void	OutputSet (int channel)
	Asserts that the specified output channel is in high state. More...
void	InputEquals (int channel, bool state)
	Asserts that the specified input channel is in the given state. More...

Properties
IDioAsserts	Assert [get]
	Represents collection of UnitTestFramework - compatible asserts defined for this type of node. More...
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 digital IO module.

Member Function Documentation

void SetDout	(	int	channel,
		bool	value
	)

Set value of an individual digital output.

Parameters

channel	The DOUT channel number [0,19].
value	The output value.

Example usage (mates_test_06.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;

namespace unit_tests
{
   [TestClass]
   public class mates_test_06
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Dio3Node node = mates.NewDio3Node(NodeId.mates_dio3_mk1_1);
               foreach (var val in new bool[]{false, true, false})
               {
                  // Assume loopback is pressent.
                  node.SetDout(0, val);
                  node.Assert.InputEquals(0, val);
               }
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

void SetDoutAll

(

int

value

)

Set value of all digital outputs.

Parameters

value

The output value, LSB is OUT01.

Example usage (mates_test_05.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;

namespace unit_tests
{
   [TestClass]
   public class mates_test_05
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Dio3Node dio = mates.NewDio3Node(NodeId.mates_dio3_mk1_1);
               // Assume there is loopback present between outputs and inputs.
               dio.SetDoutAll(0xCAFE);
               Assert.AreEqual(dio.GetDinAll(), 0xCAFE);
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

bool GetDout

(

int

channel

)

Get value of an individual digital output.

Parameters

channel

The DOUT channel number [0,19].

Returns

The result.

Example usage (mates_test_07.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;

namespace unit_tests
{
   [TestClass]
   public class mates_test_07
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Dio3Node dio = mates.NewDio3Node(NodeId.mates_dio3_mk1_1);
               // Set and verify.
               dio.SetDout(10, true);
               Assert.AreEqual(dio.GetDout(10), true);
               dio.SetDout(10, false);
               Assert.AreEqual(dio.GetDout(10), false);
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

int GetDoutAll

(

)

Get value of all digital outputs.

Returns

The result, LSB is OUT01.

Example usage (mates_test_08.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;

namespace unit_tests
{
   [TestClass]
   public class mates_test_08
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Dio3Node dio = mates.NewDio3Node(NodeId.mates_dio3_mk1_1);
               // No more than 20 outputs can be high.
               Assert.IsTrue(dio.GetDoutAll() <= 0xFFFFF);
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

bool GetDin

(

int

channel

)

Get value of an individual digital input.

Parameters

channel

The DIN channel number [0,19].

Returns

The result.

Example usage (mates_test_09.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;

namespace unit_tests
{
   [TestClass]
   public class mates_test_09
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Dio3Node dio = mates.NewDio3Node(NodeId.mates_dio3_mk1_1);
               // Enumerate all inputs.
               for (Mates.MatesInput input = Mates.MatesInput.IN01; 
                    input <= Mates.MatesInput.IN20;
                    input++)
               {
                  Console.Write("Input {0}: {1}\n", input, dio.GetDin((int)input));
               }
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

int GetDinAll

(

)

Get value of all digital inputs.

Returns

The result, LSB is IN01.

Example usage (mates_test_10.cs):

using System;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Viresco.Mates;

namespace unit_tests
{
   [TestClass]
   public class mates_test_10
   {
      [TestMethod]
      public void TestMethod()
      {
         using (Mates mates = new Mates("mates_REMOTE.mon", 1))
         {
            try
            {
               Dio3Node dio = mates.NewDio3Node(NodeId.mates_dio3_mk1_1);
               // Send 8 of inputs to the outputs.
               int output = dio.GetDoutAll();
               int input = dio.GetDinAll();
               dio.SetDoutAll((output & 0xFFF00) | (input & 0xFF));
            }
            catch
            {
               Console.Write("Cannot discover node.\n");
            }
         }
      }
   }
}

void InputSet ( int  channel )

protected

Asserts that the specified input channel is in high state.

Parameters

channel

The input channel number [0, 19].

Implements IDioAsserts.

void OutputSet ( int  channel )

protected

Asserts that the specified output channel is in high state.

Parameters

channel

The output channel number [0, 19].

Implements IDioAsserts.

void InputEquals ( int  channel, bool  state  )

protected

Asserts that the specified input channel is in the given state.

Parameters

channel	The input channel number [0, 19].
state	The expected state.

Implements IDioAsserts.

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

IDioAsserts Assert

get

Represents collection of UnitTestFramework - compatible asserts defined for this type of node.

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:

• DioNode.cs