Node Class Reference

Represents basic node with features common to all nodes. More...

Public Member Functions
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 basic node with features common to all nodes.

Member Function Documentation

bool IsCanBridge

(

)

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

Returns

True if CAN bridge, otherwise false.

int GetStatusRegister

(

)

Get the value of the status register.

Returns

The REG_COMMON_SR register value.

int GetRegisterI

(

RegisterNumber

reg

)

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

)

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
	)

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
	)

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
	)

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
	)

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

Parameters

register	The register number.
value	The expected value.

Implements INodeAsserts.

void LampTest

(

)

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

(

)

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

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

Property Documentation

int SerialNumber

get

Holds the device serial number.

string NodeIdName

get

Get string representation of this node Id (NodeId).

string NodeName

get

Get node name of this node.

---

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

• Node.cs
• MatesTypes.cs