1 karl  1.1.2.2 // Copyright (c) 2005 DMTF.  All rights reserved.
  2               // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
  3               // qualifier values to CIM Schema.</change>
  4               // ==================================================================
  5               //  CIM_AlarmDevice 
  6               // ==================================================================
  7                  [Version ( "2.8.0" ), 
  8                   UMLPackagePath ( "CIM::Device::Sensors" ), 
  9                   Description ( 
 10                      "An AlarmDevice is a type of Device that emits audible or "
 11                      "visible indications related to a problem situation." )]
 12               class CIM_AlarmDevice : CIM_LogicalDevice {
 13               
 14                     [Description ( "Boolean indicating that the Alarm is audible." )]
 15                  boolean AudibleAlarm;
 16               
 17                     [Description ( "Boolean indicating that the Alarm is visible." )]
 18                  boolean VisibleAlarm;
 19               
 20                     [Description ( 
 21                         "Boolean indicating that the Alarm causes motion of the Device."
 22 karl  1.1.2.2            )]
 23                  boolean MotionAlarm;
 24               
 25                     [Description ( 
 26                         "Urgency is an enumerated value that indicates the "
 27                         "relative frequency at which the Alarm flashes, vibrates "
 28                         "and/or emits audible tones." ), 
 29                      ValueMap { "0", "1", "2", "3", "4", "5", "6" }, 
 30                      Values { "Unknown", "Other", "Not Supported", 
 31                         "Informational", "Non-Critical", "Critical", 
 32                         "Unrecoverable" }]
 33                  uint16 Urgency;
 34               
 35                     [Description ( "The current state of the alarm." ), 
 36                      ValueMap { "0", "1", "2", "3" }, 
 37                      Values { "Unknown", "Off", "Steady", "Alternating" }]
 38                  uint16 AlarmState;
 39               
 40                     [Description ( 
 41                         "True indicates that the audio of an AlarmState indicator "
 42                         "has been disabled (i.e. muted). A disabled state here "
 43 karl  1.1.2.2           "does not imply that the AlarmState is off." )]
 44                  boolean AudioIndicatorIsDisabled;
 45               
 46                     [Description ( 
 47                         "True indicates that the visual of an AlarmState "
 48                         "indicator has been disabled (i.e. dimmed). A disabled "
 49                         "state here does not imply that the AlarmState is off." )]
 50                  boolean VisualIndicatorIsDisabled;
 51               
 52                     [Description ( 
 53                         "True indicates that the motion of an AlarmState "
 54                         "indicator has been disabled (i.e. stopped). A disabled "
 55                         "state here does not imply that the AlarmState is off." )]
 56                  boolean MotionIndicatorIsDisabled;
 57               
 58               
 59                     [Description ( 
 60                         "SetAlarmState is a method for defining the current state "
 61                         "of the Alarm. Its input parameter, RequestedAlarmState, "
 62                         "is specified using the Values list of AlarmDevice\'s "
 63                         "AlarmState property. SetAlarmState returns 0 if the "
 64 karl  1.1.2.2           "request is successfully implemented, 1 if the specified "
 65                         "RequestedAlarm State is not supported, and some other "
 66                         "value if any other error occurred. In a subclass, the "
 67                         "set of possible return codes should be specified using a "
 68                         "ValueMap qualifier on the method. The strings to which "
 69                         "the ValueMap contents are \'translated\' should be "
 70                         "specified as a Values array qualifier." )]
 71                  uint32 SetAlarmState(
 72                        [IN, Description ( "The desired state for the alarm." ), 
 73                         ValueMap { "0", "1", "2", "3" }, 
 74                         Values { "Unknown", "Off", "Steady", "Alternating" }]
 75                     uint16 RequestedAlarmState);
 76               
 77                     [Description ( 
 78                         "SetAlarmIndicator is a method for enabling or disabling "
 79                         "the indicator of the AlarmState function, without "
 80                         "changing the current AlarmState. It has 3 input "
 81                         "parameters, Audio Indicator, VisualIndicator and "
 82                         "MotionIndicator. For all of the input parameters, a "
 83                         "value of 0 indicates no change to the AlarmState "
 84                         "indicator, 1 indicates Disable, and 2 indicates Enable. "
 85 karl  1.1.2.2           "The method returns 0 if the request is successfully "
 86                         "implemented, 1 if the specified request is not "
 87                         "supported, and some other value if any other error "
 88                         "occurred. In a subclass, the set of possible return "
 89                         "codes should be specified using a ValueMap qualifier on "
 90                         "the method. The strings to which the ValueMap contents "
 91                         "are \'translated\' should be specified as a Values array "
 92                         "qualifier." )]
 93                  uint32 SetAlarmIndicator(
 94                        [IN, Description ( "The state for the audio indicator." ), 
 95                         ValueMap { "0", "1", "2" }, 
 96                         Values { "No Change", "Disable", "Enable" }]
 97                     uint16 AudioIndicator, 
 98                        [IN, Description ( "The state for the visual indicator." ), 
 99                         ValueMap { "0", "1", "2" }, 
100                         Values { "No Change", "Disable", "Enable" }]
101                     uint16 VisualIndicator, 
102                        [IN, Description ( "The state for the motion indicator." ), 
103                         ValueMap { "0", "1", "2" }, 
104                         Values { "No Change", "Disable", "Enable" }]
105                     uint16 MotionIndicator);
106 karl  1.1.2.2 
107                     [Description ( 
108                         "SetUrgency is a method for defining the desired urgency "
109                         "level for the Alarm. Its input parameter, "
110                         "RequestedUrgency, is specified using the Values list of "
111                         "AlarmDevice\'s Urgency property. SetUrgency returns 0 if "
112                         "the request is successfully implemented, 1 if the "
113                         "specified Urgency level is not supported, and some other "
114                         "value if any other error occurred. In a subclass, the "
115                         "set of possible return codes should be specified using a "
116                         "ValueMap qualifier on the method. The strings to which "
117                         "the ValueMap contents are \'translated\' should be "
118                         "specified as a Values array qualifier." )]
119                  uint32 SetUrgency(
120                        [IN, Description ( "Desired urgency for the alarm." ), 
121                         ValueMap { "1", "3", "4", "5", "6" }, 
122                         Values { "Other", "Informational", "Non-Critical", 
123                            "Critical", "Unrecoverable" }]
124                     uint16 RequestedUrgency);
125               
126               };