Apac.Dallas.OneWire.Configuration.OneWireControllerConfig Class Reference

The custom configuration element for managing a 1-Wire network (sensor array). More...

Inheritance diagram for Apac.Dallas.OneWire.Configuration.OneWireControllerConfig:

Public Member Functions
	OneWireControllerConfig (uint port, string dataCompilerRef, ushort freqSeconds, ushort delayMilliseconds, string name, string configType, string type, string description, bool prioritized)
	Creates a complete configuration element. More...
Public Member Functions inherited from Apac.Configuration.ControllerConfig
	ControllerConfig (string dataCompilerRef, ushort inputResolutionBits, ushort freqSeconds, ushort delayMilliseconds, string name, string configType, string type, string description, bool prioritized)
Public Member Functions inherited from Apac.Configuration.SupervisableConfig
	SupervisableConfig ()
	Initializes a new instance of the SupervisableConfig class. More...
	SupervisableConfig (string name, string configType, string type, string description, bool prioritized)
	Initializes a new instance of the SupervisableConfig class. More...
Public Member Functions inherited from Apac.Configuration.ConfigElement
	ConfigElement ()
	Initializes a new instance of the ConfigElement class. More...
	ConfigElement (string name, string description, bool enabled)
	Initializes a new instance of the ConfigElement class. More...
override int	GetHashCode ()
	Returns a hash code for this instance. More...
override bool	Equals (object compareTo)
	Determines whether the specified System.Object is equal to this instance. More...
System.Xml.Schema.XmlSchema	GetSchema ()
	This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the T:System.Xml.Serialization.XmlSchemaProviderAttribute to the class. More...
void	ReadXml (System.Xml.XmlReader reader)
	Generates an object from its XML representation. More...
void	WriteXml (System.Xml.XmlWriter writer)
	Converts an object into its XML representation. More...

Protected Member Functions
override void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...
override void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...
Protected Member Functions inherited from Apac.Configuration.ControllerConfig
override void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...
override void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...
Protected Member Functions inherited from Apac.Configuration.SupervisableConfig
override void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...
override void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...

Properties
int	Port [get, set]
	The number of the USB port to acquire for the 1-Wire network. A value less than zero (< 0) means to search (0-10) and use the first one. The startup sequence will be much more efficient if this is explicitly provided. More...
List< OneWireDeviceConfig >	Devices [get]
	The list of OneWireDeviceConfig elements for this controller. More...
Properties inherited from Apac.Configuration.ControllerConfig
string	CompilerRef [get, set]
	Gets or sets teh name of the supervisable component responsible for compiling the data gathered by the controller. More...
ushort	InputResolutionBits [get, set]
	Gets or sets the number of bits of resolution provided by the input registers of the device being controlled. Default value is 10 bits. More...
ushort	FrequencySeconds [get, set]
	Gets or sets the polling frequency in seconds. More...
ushort	DelayMilliseconds [get, set]
	Gets or sets the polling delay in milliseconds. This is the amount of time the thread sleeps before it checks its schedule again. Setting this to a higher number limits context switches, but decreases the resolution at which the schedule will be kept (ie: it is more likely to over-shoot the schedule if this is a big number). A lower number makes it more likely to hit the schedule accurately, but is also more CPU-intense. This is a variable so large polling frequencies, like 300, can be used and at the same time a better pause interval can be set so the poller is as efficient as possible, without constantly grinding to check if the scheduled time has arrived. More...
Properties inherited from Apac.Configuration.SupervisableConfig
string	TypeName [get, set]
	Gets or sets the name of the type of the supervisable component. More...
string	TypeForConfig [get, set]
	Gets or sets the type for the SupervisableConfig. More...
bool	Prioritized [get, set]
	Gets or sets a value indicating whether the Apac.ISupervisable is prioritized. More...
ReferenceConfigCollection	References [get]
	Gets the references. More...
Properties inherited from Apac.Configuration.ConfigElement
virtual bool	IsValid [get]
	Gives a way for subclasses to determine validity. More...
string	Name [get, set]
	Gets or sets the name property setting. More...
string	Description [get, set]
	Gets or sets the description property setting. More...
bool	Enabled [get, set]
	Gets or sets a value indicating whether this ConfigElement is enabled. More...
log4net.ILog	Log [get]
	Provides a log4net.ILog instance for use by the whole class hierarchy. More...

Detailed Description

The custom configuration element for managing a 1-Wire network (sensor array).

Constructor & Destructor Documentation

OneWireControllerConfig()

Apac.Dallas.OneWire.Configuration.OneWireControllerConfig.OneWireControllerConfig ( uint  port, string  dataCompilerRef, ushort  freqSeconds, ushort  delayMilliseconds, string  name, string  configType, string  type, string  description, bool  prioritized  )

inline

Creates a complete configuration element.

Parameters

port	The number of the USB port to acquire for the 1-Wire network. -1 means search and use the first one.
dataCompilerRef	A reference to the name of the component doing data compilation.
freqSeconds	The frequency, in seconds, which to poll for data. With this controller, that controls how often the controller checks its list of devices to see if it needs to talk to any of them based on their frequency setting.
delayMilliseconds	The delay used in the polling cycle.
name	The name (arbitrary) of this controller component.
configType	The type of the configuration class used set up this controller type.
type	The type of the controller being set up. Should be compatible with configType .
description	The description (arbitrary) of the controller.
prioritized	Indicates if the supervisable component (the controller) is to have a prioritized thread.

Member Function Documentation

OnReadXml()

override void Apac.Dallas.OneWire.Configuration.OneWireControllerConfig.OnReadXml ( System.Xml.XmlReader  reader )

inlineprotectedvirtual

Called when deserializing via XML.

Parameters

reader

The reader.

Reimplemented from Apac.Configuration.ConfigElement.

OnWriteXml()

override void Apac.Dallas.OneWire.Configuration.OneWireControllerConfig.OnWriteXml ( System.Xml.XmlWriter  writer )

inlineprotectedvirtual

Called when serializing via XML.

Parameters

writer

The writer.

Reimplemented from Apac.Configuration.ConfigElement.

Property Documentation

Devices

List<OneWireDeviceConfig> Apac.Dallas.OneWire.Configuration.OneWireControllerConfig.Devices

get

The list of OneWireDeviceConfig elements for this controller.

Port

int Apac.Dallas.OneWire.Configuration.OneWireControllerConfig.Port

getset

The number of the USB port to acquire for the 1-Wire network. A value less than zero (< 0) means to search (0-10) and use the first one. The startup sequence will be much more efficient if this is explicitly provided.

---

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

• /var/lib/jenkins/workspace/apac/APAC/Apac.Dallas.OneWire/Configuration/OneWireControllerConfig.cs