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_LogicalDevice
   |
   +--CIM_ElectricalSwitch

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis 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.
Experimentalbooleantrue
UMLPackagePathstringCIM::Device::CoolingAndPower
Versionstring2.22.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
CanProtectboolean
DescriptionstringIf 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.
ModelCorrespondencestringCIM_ElectricalSwitch.OtherEnabledState
Requiredbooleantrue
EnabledStateuint160
DescriptionstringEnabledState 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.
ModelCorrespondencestringCIM_ElectricalSwitch.OtherEnabledState
OverridestringEnabledState
ValueMapstring0, 1, 2, 3
ValuesstringUnknown, Other, Enabled, Disabled
OtherEnabledStatestring
DescriptionstringA 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".
ModelCorrespondencestringCIM_ElectricalSwitch.EnabledState, CIM_ElectricalSwitch.canProtect
OverridestringOtherEnabledState
RatedCapacityuint32
DescriptionstringThe rated current capacity in milliamperes that the switch can supply
PUnitstringampere * 10^-3
RequestedStateuint16
DescriptionstringRequestedState 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.
ModelCorrespondencestringCIM_ElectricalSwitch.EnabledState
OverridestringRequestedState
ValueMapstring0, 2, 3, 4
ValuesstringUnknown, Enabled, Disabled, Reset

Inherited Properties

NameData TypeClass Origin
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice