Class CIM_AlarmDevice
extends CIM_LogicalDevice

An AlarmDevice is a type of Device that emits audible or visible indications related to a problem situation.

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_AlarmDevice

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringAn AlarmDevice is a type of Device that emits audible or visible indications related to a problem situation.
UMLPackagePathstringCIM::Device::Sensors
Versionstring2.8.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AlarmStateuint16
DescriptionstringThe current state of the alarm.
ValueMapstring0, 1, 2, 3
ValuesstringUnknown, Off, Steady, Alternating
AudibleAlarmboolean
DescriptionstringBoolean indicating that the Alarm is audible.
AudioIndicatorIsDisabledboolean
DescriptionstringTrue indicates that the audio of an AlarmState indicator has been disabled (i.e. muted). A disabled state here does not imply that the AlarmState is off.
MotionAlarmboolean
DescriptionstringBoolean indicating that the Alarm causes motion of the Device.
MotionIndicatorIsDisabledboolean
DescriptionstringTrue indicates that the motion of an AlarmState indicator has been disabled (i.e. stopped). A disabled state here does not imply that the AlarmState is off.
Urgencyuint16
DescriptionstringUrgency is an enumerated value that indicates the relative frequency at which the Alarm flashes, vibrates and/or emits audible tones.
ValueMapstring0, 1, 2, 3, 4, 5, 6
ValuesstringUnknown, Other, Not Supported, Informational, Non-Critical, Critical, Unrecoverable
VisibleAlarmboolean
DescriptionstringBoolean indicating that the Alarm is visible.
VisualIndicatorIsDisabledboolean
DescriptionstringTrue indicates that the visual of an AlarmState indicator has been disabled (i.e. dimmed). A disabled state here does not imply that the AlarmState is off.

Inherited Properties

NameData TypeClass Origin
AllocationStatestringCIM_LogicalDevice
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
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

Local Class Methods

SetAlarmState (uint32)

Method Qualifiers (SetAlarmState)

NameData TypeValue
DescriptionstringSetAlarmState is a method for defining the current state of the Alarm. Its input parameter, RequestedAlarmState, is specified using the Values list of AlarmDevice's AlarmState property. SetAlarmState returns 0 if the request is successfully implemented, 1 if the specified RequestedAlarm State is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes should be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' should be specified as a Values array qualifier.

Method Parameters (SetAlarmState)

NameTypeQualifiers
NameData TypeValue
RequestedAlarmStateuint16
DescriptionstringThe desired state for the alarm.
INbooleantrue
ValueMapstring0, 1, 2, 3
ValuesstringUnknown, Off, Steady, Alternating

SetAlarmIndicator (uint32)

Method Qualifiers (SetAlarmIndicator)

NameData TypeValue
DescriptionstringSetAlarmIndicator is a method for enabling or disabling the indicator of the AlarmState function, without changing the current AlarmState. It has 3 input parameters, Audio Indicator, VisualIndicator and MotionIndicator. For all of the input parameters, a value of 0 indicates no change to the AlarmState indicator, 1 indicates Disable, and 2 indicates Enable. The method returns 0 if the request is successfully implemented, 1 if the specified request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes should be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' should be specified as a Values array qualifier.

Method Parameters (SetAlarmIndicator)

NameTypeQualifiers
NameData TypeValue
AudioIndicatoruint16
DescriptionstringThe state for the audio indicator.
INbooleantrue
ValueMapstring0, 1, 2
ValuesstringNo Change, Disable, Enable
MotionIndicatoruint16
DescriptionstringThe state for the motion indicator.
INbooleantrue
ValueMapstring0, 1, 2
ValuesstringNo Change, Disable, Enable
VisualIndicatoruint16
DescriptionstringThe state for the visual indicator.
INbooleantrue
ValueMapstring0, 1, 2
ValuesstringNo Change, Disable, Enable

SetUrgency (uint32)

Method Qualifiers (SetUrgency)

NameData TypeValue
DescriptionstringSetUrgency is a method for defining the desired urgency level for the Alarm. Its input parameter, RequestedUrgency, is specified using the Values list of AlarmDevice's Urgency property. SetUrgency returns 0 if the request is successfully implemented, 1 if the specified Urgency level is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes should be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' should be specified as a Values array qualifier.

Method Parameters (SetUrgency)

NameTypeQualifiers
NameData TypeValue
RequestedUrgencyuint16
DescriptionstringDesired urgency for the alarm.
INbooleantrue
ValueMapstring1, 3, 4, 5, 6
ValuesstringOther, Informational, Non-Critical, Critical, Unrecoverable

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice