AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Control.IController Interface Reference

Defines the base contract for an I/O controller that plugs into the system. More...

Inheritance diagram for Apac.Control.IController:
Apac.Control.SerialModbusController Apac.Control.ThreadedPollingController Apac.Control.UdpNodeController Apac.TcTec.Top16.Control.Top16DIOController Apac.Control.HttpController Apac.Control.MockController2 Apac.Dallas.OneWire.Control.OneWireController Apac.Dlp.Control.DlpIo20Controller Bushido.Upt.Control.PegController

Public Member Functions

IEnumerable< ControllerDescriptorGetDescriptors ()
 Gets the descriptors for the controller, which might include more than one due to some architectures that can have more than one input board, or addressable source, for use during measurement configuration. More...
 

Properties

ushort Resolution [get]
 Gets the resolution value, not number of bits. IE: 4096 == 16 bits. More...
 
ulong[] SensorIds [get]
 Gets the identification numbers of the sensors that are actively available to the controller. This helps with system discovery and setup. More...
 
ushort PollFrequency [get]
 Gets the poll frequency (in seconds). More...
 
ushort DelayDuration [get]
 Gets the duration of the delay (in milliseconds). More...
 

Detailed Description

Defines the base contract for an I/O controller that plugs into the system.

Member Function Documentation

◆ GetDescriptors()

IEnumerable<ControllerDescriptor> Apac.Control.IController.GetDescriptors ( )

Gets the descriptors for the controller, which might include more than one due to some architectures that can have more than one input board, or addressable source, for use during measurement configuration.

Returns

Implemented in Apac.TcTec.Top16.Control.Top16DIOController, Apac.Control.UdpNodeController, Apac.Control.ThreadedPollingController, Apac.Control.SerialModbusController, and Apac.Dlp.Control.DlpIo20Controller.

Property Documentation

◆ DelayDuration

ushort Apac.Control.IController.DelayDuration
get

Gets the duration of the delay (in milliseconds).

The duration of the delay.

◆ PollFrequency

ushort Apac.Control.IController.PollFrequency
get

Gets the poll frequency (in seconds).

◆ Resolution

ushort Apac.Control.IController.Resolution
get

Gets the resolution value, not number of bits. IE: 4096 == 16 bits.

◆ SensorIds

ulong [] Apac.Control.IController.SensorIds
get

Gets the identification numbers of the sensors that are actively available to the controller. This helps with system discovery and setup.

Note that not all of these sensors must be mapped to readings, just that they are available via the controller for use as inputs. Also, If the controller is unable to determine if sensors are actually attached, it should just return the list of possible sensor IDs.


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