Click or drag to resize

GenericDevice Class

Generic device class for use in SIMPL# Pro.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      More

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class GenericDevice : GenericBase

The GenericDevice type exposes the following members.

Constructors
 NameDescription
Protected methodGenericDevice Constructor for the base class.
Top
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.
(Overrides GenericBaseConnectedIpList)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Overrides GenericBaseDisposed)
Public propertyID Property to get the ID of the device.
(Overrides GenericBaseID)
Public propertyIsOnline Property to get the current online state of the device.
(Overrides GenericBaseIsOnline)
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.
(Overrides GenericBaseRegisterable)
Public propertyRegistered Property to get the current registration state of the device.
(Overrides GenericBaseRegistered)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Overrides GenericBaseRegistrationFailureReason)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Overrides GenericBaseSIMPLDeviceImplementation)
Public propertyType Property to determine to type of device this is.
(Overrides GenericBaseType)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Overrides GenericBaseUnRegistrationFailureReason)
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.
Top
Methods
 NameDescription
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Overrides GenericBaseDispose(Boolean))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Overrides ObjectFinalize)
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 Register this device with the system.
(Overrides GenericBaseRegister)
Public methodToString Return the name of the device.
(Overrides ObjectToString)
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.


(Overrides GenericBaseUnRegister)
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.
(Overrides GenericBaseIpInformationChange)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Overrides GenericBaseOnlineStatusChange)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.AudioDistributionC2nAmp
      Crestron.SimplSharpPro.AudioDistributionCnAmpxBase
      Crestron.SimplSharpPro.AudioDistributionCnxPad8Base
      Crestron.SimplSharpPro.AudioDistributionCommercialAmplifier
      Crestron.SimplSharpPro.AudioDistributionDmNaxSc
      Crestron.SimplSharpPro.AudioDistributionDmNaxXBase
      Crestron.SimplSharpPro.AudioDistributionDspMixerBase
      Crestron.SimplSharpPro.AudioDistributionSwamp
      Crestron.SimplSharpPro.CrestronConnectedCrestronConnectedAvr
      Crestron.SimplSharpPro.CrestronConnectedCrestronConnectedAvrV2
      Crestron.SimplSharpPro.CrestronConnectedCrestronConnectedDisplayV2
      Crestron.SimplSharpPro.CrestronConnectedRoomViewConnectedDisplay
      Crestron.SimplSharpPro.DeviceSupportBasicTriList
      Crestron.SimplSharpPro.DeviceSupportClcLedPwmRgbBaseClass
      Crestron.SimplSharpPro.DeviceSupportGlExpClxDimBase
      Crestron.SimplSharpPro.DeviceSupportHDBaseTBase
      Crestron.SimplSharpPro.DeviceSupportKeypadBase
      Crestron.SimplSharpPro.DeviceSupportLightingBase
      Crestron.SimplSharpPro.DeviceSupportShadeBase
      Crestron.SimplSharpPro.DM.AirMediaAmBase
      Crestron.SimplSharpPro.DM.CardsCardDevice
      Crestron.SimplSharpPro.DM.EndpointsDMEndpointBase
      Crestron.SimplSharpPro.DMHDScaler
      Crestron.SimplSharpPro.DM.StreamingDm100xStrBase
      Crestron.SimplSharpPro.DM.StreamingDmfXx4kSfp
      Crestron.SimplSharpPro.DM.StreamingDmTxRx100Str
      Crestron.SimplSharpPro.DM.StreamingDmXioDirectorBase
      Crestron.SimplSharpPro.DMSwitch
      Crestron.SimplSharpPro.DM.VideoWindowingHdWp4k401C
      Crestron.SimplSharpPro.EthernetCommunicationEthernetSwitchBase
      Crestron.SimplSharpPro.FusionFusionBase
      Crestron.SimplSharpProGatewayBase
      Crestron.SimplSharpPro.GatewaysC2nIRGw
      Crestron.SimplSharpPro.GeneralIOAxxess
      Crestron.SimplSharpPro.GeneralIOC2nIo
      Crestron.SimplSharpPro.GeneralIOC2nRths
      Crestron.SimplSharpPro.GeneralIOCenIoCom
      Crestron.SimplSharpPro.GeneralIOCenIoDi
      Crestron.SimplSharpPro.GeneralIOCenIoIr
      Crestron.SimplSharpPro.GeneralIOCenIoRy
      Crestron.SimplSharpPro.GeneralIOCenOdtCPoe
      Crestron.SimplSharpPro.GeneralIOCsaPws10sHub
      Crestron.SimplSharpPro.GeneralIOCsaPws10sHubEnetBase
      Crestron.SimplSharpPro.GeneralIODinCenCn2
      Crestron.SimplSharpPro.GeneralIODinIo8
      Crestron.SimplSharpPro.GeneralIOFt2aCblr1t
      Crestron.SimplSharpPro.GeneralIOGlsLcct
      Crestron.SimplSharpPro.GeneralIOGlsLdlExBatt
      Crestron.SimplSharpPro.GeneralIOGlsOccupancySensorBase
      Crestron.SimplSharpPro.GeneralIOGlsOirCsmExBatt
      Crestron.SimplSharpPro.GeneralIOGlsPartCn
      Crestron.SimplSharpPro.GeneralIOGlsSim
      Crestron.SimplSharpPro.GeneralIOInetIoexIrcom
      Crestron.SimplSharpPro.GeneralIOInetIoexRyio
      Crestron.SimplSharpPro.GeneralIOInetsIoexDoorBatt
      Crestron.SimplSharpPro.GeneralIO.PowerConditionersPcXxx
      Crestron.SimplSharpPro.GeneralIOStatusSign
      Crestron.SimplSharpPro.GeneralIOStCom
      Crestron.SimplSharpPro.GeneralIOStIo
      Crestron.SimplSharpPro.KeypadsC2nLcdBXXBaseClass
      Crestron.SimplSharpPro.KeypadsTtxBase
      Crestron.SimplSharpPro.LightingClciMcex
      Crestron.SimplSharpPro.LightingClx1Fan4
      Crestron.SimplSharpPro.LightingClx1Mc4
      Crestron.SimplSharpPro.LightingClx4Hsw4
      Crestron.SimplSharpPro.Lighting.DinDinBaseClassT
      Crestron.SimplSharpPro.LightingDin2Mc2
      Crestron.SimplSharpPro.LightingDinDali2
      Crestron.SimplSharpPro.LightingDinDliBase
      Crestron.SimplSharpPro.LightingGlxxDimFlv
      Crestron.SimplSharpPro.Lighting.MeteringGlsEmMcu
      Crestron.SimplSharpPro.LightingZummeshNetbridge
      Crestron.SimplSharpPro.Lighting.ZumWiredZumLinkJBoxIoInputs
      Crestron.SimplSharpPro.Lighting.ZumWiredZumNetBridgeBase
      Crestron.SimplSharpPro.LocksGenericDoorLock
      Crestron.SimplSharpPro.LocksYaleLock
      Crestron.SimplSharpPro.MediaAutonomicMms
      Crestron.SimplSharpPro.MediaCenTrack
      Crestron.SimplSharpPro.MediaHdXspBase
      Crestron.SimplSharpPro.MediaMediaBase
      Crestron.SimplSharpPro.RemotesHr1x0WirelessRemoteBase
      Crestron.SimplSharpPro.RemotesRc5UniversalRemote
      Crestron.SimplSharpPro.RemotesWirelessPagedRemoteBase
      Crestron.SimplSharpPro.RemotesWpr48
      Crestron.SimplSharpPro.ShadesC2nSxcBaseClass
      Crestron.SimplSharpPro.ThermostatsBasalteDeseo
      Crestron.SimplSharpPro.ThermostatsChvTstatFcuHotelPir10Base
      Crestron.SimplSharpPro.ThermostatsDin1Tstat8
      Crestron.SimplSharpPro.ThermostatsDinTstatFcu
      Crestron.SimplSharpPro.ThermostatsThermostat
      Crestron.SimplSharpPro.UCAm100
      Crestron.SimplSharpPro.UCUcEngineSdZ
      Crestron.SimplSharpPro.UICaptureHdBase
      Crestron.SimplSharpPro.UIRigelDock
      Crestron.SimplSharpPro.UIVpg24Base
      Crestron.SimplSharpPro.UIVpgBase
      Crestron.SimplSharpProUsbHid
      Crestron.SimplSharpProXioCloudRoomSlot