Class DeviceConfigSetting

Contains the logic for calling the methods associated with a setting for a given device.

Inheritance

System.Object

DeviceConfigSetting

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Phoenix.DeviceConfiguration

Assembly: Phoenix.DeviceConfiguration.dll

Syntax

public class DeviceConfigSetting

Constructors

DeviceConfigSetting(Dictionary<String, SettingInformation>, String, String, IEnumerable<IDevice>)

Initializes a new instance of the DeviceConfigSetting class.

Declaration

public DeviceConfigSetting(Dictionary<string, SettingInformation> settingsForDevice, string expectedValue, string data, IEnumerable<IDevice> devices)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, SettingInformation>	settingsForDevice	The setting information objects we are wrapping, keyed by the device type name.
System.String	expectedValue	The expected value according to the configuration settings.
System.String	data	Data to pass to the configuration setting.
System.Collections.Generic.IEnumerable<IDevice>	devices	The devices that we are checking.

Properties

CanCheck

Gets a value indicating whether the setting can checked.

Declaration

public bool CanCheck { get; }

Property Value

Type	Description
System.Boolean

CanFix

Gets a value indicating whether the setting can be fixed automatically.

Declaration

public bool CanFix { get; }

Property Value

Type	Description
System.Boolean

CurrentValue

Gets the current value of this setting.

Declaration

public string CurrentValue { get; }

Property Value

Type	Description
System.String

Data

Gets data to pass to the fix setting.

Declaration

public string Data { get; }

Property Value

Type	Description
System.String

Devices

Gets the collection of devices associated with the setting.

Declaration

public ICollection<IDevice> Devices { get; }

Property Value

Type	Description
System.Collections.Generic.ICollection<IDevice>

ExpectedValue

Gets the expected value of this setting.

Declaration

public string ExpectedValue { get; }

Property Value

Type	Description
System.String

HasMultipleValues

Gets a value indicating whether or not multiple values were retrieved for the setting.

Declaration

public bool HasMultipleValues { get; }

Property Value

Type	Description
System.Boolean

IsCorrect

Gets a value indicating whether the value is correct.

Declaration

public bool? IsCorrect { get; }

Property Value

Type	Description
System.Nullable<System.Boolean>

LastResults

Gets the last results returned from each device.

Declaration

public ConcurrentDictionary<IDevice, DeviceConfigResult> LastResults { get; }

Property Value

Type	Description
System.Collections.Concurrent.ConcurrentDictionary<IDevice, DeviceConfigResult>

Message

Gets an optional message from the combined results from the last run.

Declaration

public string Message { get; }

Property Value

Type	Description
System.String

SettingName

Gets the setting name

Declaration

public string SettingName { get; }

Property Value

Type	Description
System.String

Methods

CheckSetting()

Invokes the check method for this setting.

Declaration

public Task CheckSetting()

Returns

Type	Description
System.Threading.Tasks.Task	A task that completes when the check finishes on all devices.

FixSetting()

Invokes the fix method for this setting.

Declaration

public async Task FixSetting()

Returns

Type	Description
System.Threading.Tasks.Task	A task that completes when the fix finishes on all devices.