Click or drag to resize

DmXioDirectorBase Class

Base class for DmXioDirector80, DmXioDirector160 and DmXioDirectorEnterprise device classes.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.DM.Streaming
Assembly: Crestron.SimplSharpPro.DM (in Crestron.SimplSharpPro.DM.dll) Version: 2.21.121
Syntax
C#
public class DmXioDirectorBase : GenericDevice, 
	IDisposable

The DmXioDirectorBase type exposes the following members.

Properties
 NameDescription
Public propertyConnectedIpList A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed.
(Inherited from GenericDevice)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDeviceFunctions Device Functions property of this device.
Public propertyDisposed Property to indicate if the Device has been disposed. use this from the base GenericDevice...
(Overrides GenericDeviceDisposed)
Public propertyDmXioDirectorType Property to retrieve the type of XiO Director that has been instantiated. See eDmXioDirectorType for further details.
Public propertyDomain Collection of Domains.
Public propertyGlobalDomain Global Domain property of this device.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyMaximumNumberOfDomains This property will return the maximum number of domains allowed on the given XiO Director.
Public propertyMaximumNumberOfEndpoints This property will return the maximum number of endpoints allowed across all domains on a given XiO director.
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyTotalNumberOfDomains Property to report the total number of domains defined in the system.
Public propertyTotalNumberOfEndpoints Property to report the total number of endpoints in the system.
Public propertyTotalNumberOfReceiverEndpoints Property to report the total number of receiver endpoints in the system. Note: This only reports endpoints added to the director from the current user program
Public propertyTotalNumberOfTransmitterEndpoints Property to report the total number of transmitter endpoints in the system. Note: This only reports endpoints added to the director from the current user program
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Protected propertyXioEndpointStubSIMPLDevice The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy.
(Inherited from GenericDevice)
Top
Methods
 NameDescription
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) This will remove all domains and the endpoints.
(Overrides GenericDeviceDispose(Boolean))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the XiO Director will make sure to dispose of everything.
(Overrides GenericDeviceFinalize)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Public methodRegister This will Register the XiO Director and any endpoints that have been created under the domain(s). If you add endpoints after calling Register() on the XiO Director, you will have to call UnRegister() and then Register() again to make sure the XiO Director is refreshed with the correct endpoint information.
(Overrides GenericDeviceRegister)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister Unregister this device with the system. This function can not be called from the device's own SigChange event handler.

On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventIpInformationChange Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Fields
 NameDescription
Public fieldStatic memberDeviceFailedEventId The state of FailedFeedback has changed.

The DeviceFunctionChange event will trigger for this event id and Index will indicate the index into the DeviceStatusCollection collection.

Public fieldStatic memberDeviceGoodEventId The state of GoodFeedback has changed.

The DeviceFunctionChange event will trigger for this event id and Index will indicate the index into the DeviceStatusCollection collection.

Public fieldStatic memberEndpointNameFeedbackEventId The value of EndpointName property has changed.

The EndpointNameChange event will trigger for this event id and the Index indicates the Endpoint ID (valid values are from 1-1000).

Public fieldStatic memberSystemTemperatureFeedbackEventId The value of SystemTemperatureFeedback has changed.

The DeviceFunctionChange event will trigger for this event id.

Public fieldStatic memberSystemTemperatureInCentigradeFeedbackEventId The value of SystemTemperatureInCentigradeFeedback has changed.

The DeviceFunctionChange event will trigger for this event id.

Public fieldStatic memberTotalNumberOfDomainsFeedbackEventId The value of TotalNumberOfDomains property has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTotalNumberOfEndpointsFeedbackEventId The value of TotalNumberOfEndpoints property has changed.

The BaseEvent event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also