Class ErrorDevice

Represents a device that is in a broken state. Used when an exception on device creation is not handled on load.

Inheritance

System.Object

ErrorDevice

Implements

IDevice

ICapability

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.DeviceManagement

Assembly: Phoenix.Core.dll

Syntax

public class ErrorDevice : IDevice, ICapability

Constructors

View Source

ErrorDevice(String, String, String, IPAddress, String, DeviceConnectionStatus, IEventAggregator, Guid)

Initializes a new instance of the ErrorDevice class.

Declaration

public ErrorDevice(string deviceTypeName, string name, string alias, IPAddress address, string uniqueId, DeviceConnectionStatus status, IEventAggregator events, Guid phoenixId)

Parameters

Type	Name	Description
System.String	deviceTypeName	The name of the device type that has failed.
System.String	name	The name of the device in error.
System.String	alias	The alias for the device.
System.Net.IPAddress	address	The ip address of the device in error.
System.String	uniqueId	The ID the device in error.
DeviceConnectionStatus	status	The status of the device in error.
IEventAggregator	events	The event aggregator service.
System.Guid	phoenixId	The id for the error device.

Properties

View Source

Alias

Gets or sets a user defined alias for the device.

Declaration

public string Alias { get; set; }

Property Value

Type	Description
System.String

View Source

AttachedObjectModel

Gets or sets the game object model that is attached to this device.

Declaration

public object AttachedObjectModel { get; set; }

Property Value

Type	Description
System.Object

View Source

Configuration

Gets or sets the configuration string for this device.

Declaration

public string Configuration { get; set; }

Property Value

Type	Description
System.String

View Source

ConfigurationType

Declaration

public string ConfigurationType { get; set; }

Property Value

Type	Description
System.String

View Source

ConnectionStatus

Gets or sets a value indicating the device connection status.

Declaration

public DeviceConnectionStatus ConnectionStatus { get; set; }

Property Value

Type	Description
DeviceConnectionStatus

View Source

DeviceImplementation

Gets or sets the underlying device implementation.

Declaration

public object DeviceImplementation { get; set; }

Property Value

Type	Description
System.Object

View Source

DeviceTypeDisplayName

Gets the display name of the device type.

Declaration

public string DeviceTypeDisplayName { get; }

Property Value

Type	Description
System.String

View Source

DeviceTypeName

Gets the name of the device type.

Declaration

public string DeviceTypeName { get; }

Property Value

Type	Description
System.String

View Source

DisplayName

Gets the display name for UI and logging. This is the Name if valid or the IPAddress.

Declaration

public string DisplayName { get; }

Property Value

Type	Description
System.String

View Source

Events

Gets the event aggregator service.

Declaration

protected IEventAggregator Events { get; }

Property Value

Type	Description
IEventAggregator

View Source

Id

Gets or sets the unique identifier of the device.

Declaration

public string Id { get; protected set; }

Property Value

Type	Description
System.String

View Source

IPAddress

Gets the IPAddress of this device.

Declaration

public IPAddress IPAddress { get; }

Property Value

Type	Description
System.Net.IPAddress

View Source

Name

Gets or sets the name of this device.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

View Source

PhoenixId

Gets a value representing the identifier phoenix places on the device for tracking.

Declaration

public Guid PhoenixId { get; }

Property Value

Type	Description
System.Guid

View Source

XboxLiveDeviceId

Gets a value representing the XBL device Id.

Declaration

public string XboxLiveDeviceId { get; }

Property Value

Type	Description
System.String

Methods

View Source

Cleanup()

Performs device cleanup

Declaration

public void Cleanup()

View Source

GetCapabilityInterface<T>()

Returns the interface requested for this object.

Declaration

public T GetCapabilityInterface<T>()
    where T : class

Returns

Type	Description
T	The interface if it is implemented or null if not implemented.

Type Parameters

Name	Description
T	The interface that is being requested.

View Source

HasCapabilityInterface(Type)

Determines if this object implements the specified interface type.

Declaration

public bool HasCapabilityInterface(Type type)

Parameters

Type	Name	Description
System.Type	type	The type of interface to check.

Returns

Type	Description
System.Boolean	A value indicating whether the object implements the interface or not.

View Source

Serialize()

Declaration

public SerializableIDevice Serialize()

Returns

Type	Description
SerializableIDevice

Implements

IDevice

ICapability