Apac.Configuration.ControllerDescriptor Class Reference

A construct used to describe a controller definition so that information can be shared across application boundaries with client code without having to share the actual controller object. More...

Inheritance diagram for Apac.Configuration.ControllerDescriptor:

Public Member Functions
	ControllerDescriptor (string name, string descr, ushort pollFrequency, ushort delayDuration, ushort resolutionBits, ulong[] sensorIds)
	Initializes a new instance of the ControllerDescriptor class. More...
	ControllerDescriptor (string name)
	Initializes a new instance of the ControllerDescriptor class. More...
void	AddSensor (ulong sensorId)
	Adds a port to the desription. More...
void	GetObjectData (SerializationInfo info, StreamingContext context)
	Populates a T:System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object. More...

Protected Member Functions
	ControllerDescriptor (SerializationInfo info, StreamingContext context)
	Initializes a new instance of the ControllerDescriptor class during deserialization. More...

Properties
string	Name [get]
	Gets or sets the name. More...
string	Description [get]
	Gets the description. More...
ushort	ResolutionBits [get]
	Gets the resolution bits. More...
ushort	PollFrequency [get]
	Gets the polling frequency (in seconds). More...
ushort	DelayDuration [get]
	Gets the duration of the delay (in milliseconds). This is the amount of automatic delay between polls during which the worker thread is sleeping. More...
ulong[]	SensorIds [get]
	Gets the sensor identifiers. More...
string[]	SensorIdsStr [get]

Detailed Description

A construct used to describe a controller definition so that information can be shared across application boundaries with client code without having to share the actual controller object.

Constructor & Destructor Documentation

ControllerDescriptor() [1/3]

Apac.Configuration.ControllerDescriptor.ControllerDescriptor ( SerializationInfo  info, StreamingContext  context  )

inlineprotected

Initializes a new instance of the ControllerDescriptor class during deserialization.

Parameters

info	The info.
context	The context.

ControllerDescriptor() [2/3]

Apac.Configuration.ControllerDescriptor.ControllerDescriptor ( string  name, string  descr, ushort  pollFrequency, ushort  delayDuration, ushort  resolutionBits, ulong[]  sensorIds  )

inline

Initializes a new instance of the ControllerDescriptor class.

Parameters

name	The name.
descr	The description of the controller.
pollFrequency	The poll frequency (see PollFrequency).
delayDuration	Duration of the delay between polls (see DelayDuration).
resolutionBits	The resolution in bits.
sensorIds	The identifiers of the sensors available from the controller.

ControllerDescriptor() [3/3]

Apac.Configuration.ControllerDescriptor.ControllerDescriptor ( string  name )

inline

Initializes a new instance of the ControllerDescriptor class.

Parameters

name

The name.

Member Function Documentation

AddSensor()

void Apac.Configuration.ControllerDescriptor.AddSensor ( ulong  sensorId )

inline

Adds a port to the desription.

Parameters

sensorId

The ID of the sensor.

GetObjectData()

void Apac.Configuration.ControllerDescriptor.GetObjectData ( SerializationInfo  info, StreamingContext  context  )

inline

Populates a T:System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

Parameters

info	The T:System.Runtime.Serialization.SerializationInfo to populate with data.
context	The destination (see T:System.Runtime.Serialization.StreamingContext) for this serialization.

Exceptions

T:System.Security.SecurityException

The caller does not have the required permission.

Property Documentation

DelayDuration

ushort Apac.Configuration.ControllerDescriptor.DelayDuration

get

Gets the duration of the delay (in milliseconds). This is the amount of automatic delay between polls during which the worker thread is sleeping.

The duration of the delay.

Description

string Apac.Configuration.ControllerDescriptor.Description

get

Gets the description.

Name

string Apac.Configuration.ControllerDescriptor.Name

get

Gets or sets the name.

The name.

PollFrequency

ushort Apac.Configuration.ControllerDescriptor.PollFrequency

get

Gets the polling frequency (in seconds).

ResolutionBits

ushort Apac.Configuration.ControllerDescriptor.ResolutionBits

get

Gets the resolution bits.

SensorIds

ulong [] Apac.Configuration.ControllerDescriptor.SensorIds

get

Gets the sensor identifiers.

---

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

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/ControllerDescriptor.cs