# Class CIM_ElectricalSwitch
extends CIM_LogicalDevice

This class is a representation of logical properties of a generic electrical switch. An example of an electric switch is a circuit breaker. An electrical switch is used to interrupt the flow of power. When the switch is open, power flow is interrupted.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_AllocatedLogicalElement
|
+--CIM_LogicalDevice
|
+--CIM_ElectricalSwitch

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | This class is a representation of logical properties of a generic electrical switch. An example of an electric switch is a circuit breaker. An electrical switch is used to interrupt the flow of power. When the switch is open, power flow is interrupted.
Experimental | boolean | true
UMLPackagePath | string | CIM::Device::CoolingAndPower
Version | string | 2.22.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CanProtect | boolean |
Description | string | If this device provides protective function, this value shall be set to true (e.g. a circuit breaker). OtherEnabledState cannot have a value of "Tripped" unless this property is true.
ModelCorrespondence | string | CIM_ElectricalSwitch.OtherEnabledState
Required | boolean | true
EnabledState | uint16 | 0
Description | string | EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. The following text briefly summarizes the various states: "Unknown" (0) indicates that the state of the switch is unknown. "Enabled" (2) indicates that the switch is closed. "Disabled" (3) indicates that the switch is open.
ModelCorrespondence | string | CIM_ElectricalSwitch.OtherEnabledState
Override | string | EnabledState
ValueMap | string | 0, 1, 2, 3
Values | string | Unknown, Other, Enabled, Disabled
OtherEnabledState | string |
Description | string | A string that describes the enabled or disabled state of the element when the EnabledState property is set to "Other" (1). This property must be set to NULL when EnabledState is any value other than 1. If the switch is tripped, the value shall be "Tripped".
ModelCorrespondence | string | CIM_ElectricalSwitch.EnabledState, CIM_ElectricalSwitch.canProtect
Override | string | OtherEnabledState
RatedCapacity | uint32 |
Description | string | The rated current capacity in milliamperes that the switch can supply
PUnit | string | ampere * 10^-3
RequestedState | uint16 |
Description | string | RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. This property overriddes the parent class and is a subset of the values. The following values are valid: "Unknown" (0) indicates the last requested state for the element is unknown. If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0) This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.
ModelCorrespondence | string | CIM_ElectricalSwitch.EnabledState
Override | string | RequestedState
ValueMap | string | 0, 2, 3, 4
Values | string | Unknown, Enabled, Disabled, Reset

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
AllocationState | string | CIM_LogicalDevice
Availability | uint16 | CIM_LogicalDevice
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_LogicalDevice
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
DeviceID | string | CIM_LogicalDevice
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
ErrorCleared | boolean | CIM_LogicalDevice
ErrorDescription | string | CIM_LogicalDevice
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
LastErrorCode | uint32 | CIM_LogicalDevice
LocationIndicator | uint16 | CIM_LogicalDevice
MaxQuiesceTime | uint64 | CIM_LogicalDevice
Name | string | CIM_ManagedSystemElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
PowerManagementSupported | boolean | CIM_LogicalDevice
PowerOnHours | uint64 | CIM_LogicalDevice
PrimaryStatus | uint16 | CIM_ManagedSystemElement
Status | string | CIM_ManagedSystemElement
StatusInfo | uint16 | CIM_LogicalDevice
SystemCreationClassName | string | CIM_LogicalDevice
SystemName | string | CIM_LogicalDevice
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TotalPowerOnHours | uint64 | CIM_LogicalDevice
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AdditionalAvailability | uint16[] | CIM_LogicalDevice
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
IdentifyingDescriptions | string[] | CIM_LogicalDevice
OperationalStatus | uint16[] | CIM_ManagedSystemElement
OtherIdentifyingInfo | string[] | CIM_LogicalDevice
PowerManagementCapabilities | uint16[] | CIM_LogicalDevice
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
EnableDevice | uint32 | CIM_LogicalDevice
OnlineDevice | uint32 | CIM_LogicalDevice
QuiesceDevice | uint32 | CIM_LogicalDevice
RequestStateChange | uint32 | CIM_EnabledLogicalElement
Reset | uint32 | CIM_LogicalDevice
RestoreProperties | uint32 | CIM_LogicalDevice
SaveProperties | uint32 | CIM_LogicalDevice
SetPowerState | uint32 | CIM_LogicalDevice