Click or drag to resize

PoeSwitchBase Class

Base class for POE Switch devices.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.EthernetCommunication
Assembly: Crestron.SimplSharpPro.EthernetCommunications (in Crestron.SimplSharpPro.EthernetCommunications.dll) Version: 2.21.121
Syntax
C#
public class PoeSwitchBase : EthernetSwitchBase

The PoeSwitchBase type exposes the following members.

Constructors
 NameDescription
Protected methodPoeSwitchBase Constructor for instantiating POE switch devices.
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.
(Inherited from GenericDevice)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisableAllPoePorts Input status to disable all the POE ports on the switch when a rising edge is applied.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableAllPoePorts Input status for enabling all the POE ports on the switch when applies a rising edge.
Public propertyFanSpeedFeedbackInPercent Indicates the POE switch's cooling fan speed in percent of 65535.
Public propertyFanSpeedFeedbackInRPM Indicates the POE switch's cooling fan speed in rpm's.
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 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 propertyPorts Collection of POE ports supported by the device.
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 propertyTemperatureFeedbackInCelsius Reports the POE switch's temperature in degree Celsius.
Public propertyTemperatureFeedbackInFahrenheit Reports the POE switch's temperature in degree Fahrenheit.
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) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitializeEthernetSwitchBase Method to initialize the Ethernet switch base.
(Inherited from EthernetSwitchBase)
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)
Protected methodOnPoePortStateChange Event handler for POE Port events.
Protected methodOnPortStateChange Event handler for Ethernet Port events.
(Inherited from EthernetSwitchBase)
Public methodPoeDisableAll Method to disable all the POE ports on the switch with a rising edge.
Public methodPoeEnableAll Method to enable all the POE ports on the switch with a rising edge.
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
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)
Public eventPoePortStateChange Event fired when a POE port state change was received from the device. The user needs to subscribe this event with an event handler having the same signature of PoePortEventHandler.
Public eventPortStateChange Event fired when a Ethernet port state change was received from the device.
(Inherited from EthernetSwitchBase)
Top
Fields
 NameDescription
Protected field_FanSpeedFeedbackInPercentage Indicates the POE switch's cooling fan speed in percent of 65535.
Protected field_FanSpeedFeedbackInRPM Indicates the POE switch's cooling fan speed in rpm's.
Protected field_PoeDisableAll Disables all the POE ports on the switch as long as the input is true. No effect when the input is false.
Protected field_PoeEnableAll Enables all the POE ports on the switch as long as the input is true. No effect when the input is false.
Protected field_PoePorts Collection that contains POE Port objects.
Protected field_Ports Collection that contains Ethernet Port objects.
(Inherited from EthernetSwitchBase)
Protected field_TemperatureFeedbackInC Reports the POE switch's temperature in degree Celsius.
Protected field_TemperatureFeedbackInF Reports the POE switch's temperature in degree Fahrenheit.
Public fieldStatic memberFanSpeedInPercentFeedbackEventId Event ID for the base event to report the switch fan speed change in percent of 6553.
Public fieldStatic memberFanSpeedInRPMFeedbackEventId Event ID for the base event to report the switch fan speed change in RPM.
Public fieldStatic memberTemperatureInCelsiusFeedbackEventId Event ID for the base event to report the switch temperature change in degree Celsius.
Public fieldStatic memberTemperatureInFahrenheitFeedbackEventId Event ID for the base event to report the switch temperature change in degree Fahrenheit.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also