Class: WMI::CIM_AlarmDevice

Inherits:
Base
  • Object
show all
Defined in:
lib/CIM_AlarmDevice.rb

Overview

アラーム デバイスは、問題の状況に関連する可聴表示、または可視表示を処理するデバイスの種類です。

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Base

#AddRef, #AssociatorsAsync_, #Associators_, #Clone_, #CompareTo_, #DeleteAsync_, #Delete_, #Derivation_, #ExecMethodAsync_, #ExecMethod_, #GetIDsOfNames, #GetObjectText_, #GetText_, #GetTypeInfo, #GetTypeInfoCount, #InstancesAsync_, #Instances_, #Invoke, #Methods_, #Path_, #Properties_, #PutAsync_, #Put_, #Qualifiers_, #QueryInterface, #ReferencesAsync_, #References_, #Refresh_, #Release, #Security_, #SetFromText_, #SpawnDerivedClass_, #SpawnInstance_, #SubclassesAsync_, #Subclasses_, #SystemProperties_

Instance Attribute Details

- (boolean) AudibleAlarm (readonly)

アラームが可聴であることを示すブール値です。

Returns:

  • (boolean)

    AudibleAlarm



41
42
43
# File 'lib/CIM_AlarmDevice.rb', line 41

def AudibleAlarm
  @AudibleAlarm
end

- (uint16) Availability (readonly)

デバイスの利用可能性と状態です。

 

Returns:

  • (uint16)

    Availability



51
52
53
# File 'lib/CIM_AlarmDevice.rb', line 51

def Availability
  @Availability
end

- (string) Caption (readonly)

Caption プロパティは、オブジェクトについての簡単な説明 (1 行分の文字列) です。

Returns:

  • (string)

    Caption



56
57
58
# File 'lib/CIM_AlarmDevice.rb', line 56

def Caption
  @Caption
end

- (uint32) ConfigManagerErrorCode (readonly)

Win32 構成マネージャのエラー コードを示します。

 

Returns:

  • (uint32)

    ConfigManagerErrorCode



129
130
131
# File 'lib/CIM_AlarmDevice.rb', line 129

def ConfigManagerErrorCode
  @ConfigManagerErrorCode
end

- (boolean) ConfigManagerUserConfig (readonly)

デバイスがユーザー定義の構成を使用しているかどうかを示します。

Returns:

  • (boolean)

    ConfigManagerUserConfig



134
135
136
# File 'lib/CIM_AlarmDevice.rb', line 134

def ConfigManagerUserConfig
  @ConfigManagerUserConfig
end

- (string) CreationClassName (readonly)

CreationClassName は、インスタンスの作成で使用されるクラス名、またはサブクラス名を示します。

 

Returns:

  • (string)

    CreationClassName



140
141
142
# File 'lib/CIM_AlarmDevice.rb', line 140

def CreationClassName
  @CreationClassName
end

- (string) Description (readonly)

Description プロパティでオブジェクトの説明が提供されます。

Returns:

  • (string)

    Description



146
147
148
# File 'lib/CIM_AlarmDevice.rb', line 146

def Description
  @Description
end

- (string) DeviceID (readonly)

DeviceID は論理デバイスを一意に名前付けするためのアドレス、またはほかの識別情報です。

Returns:

  • (string)

    DeviceID



151
152
153
# File 'lib/CIM_AlarmDevice.rb', line 151

def DeviceID
  @DeviceID
end

- (boolean) ErrorCleared (readonly)

ErrorCleared は LastErrorCode プロパティで報告されたエラーが現在は消去されていることを示すブール値のプロパティです。

Returns:

  • (boolean)

    ErrorCleared



156
157
158
# File 'lib/CIM_AlarmDevice.rb', line 156

def ErrorCleared
  @ErrorCleared
end

- (string) ErrorDescription (readonly)

ErrorDescription は LastErrorCode プロパティで記録されたエラーに関する情報および実行される可能性がある修正の情報を提供する自由形式の文字列です。

Returns:

  • (string)

    ErrorDescription



161
162
163
# File 'lib/CIM_AlarmDevice.rb', line 161

def ErrorDescription
  @ErrorDescription
end

- (datetime) InstallDate (readonly)

InstallDate プロパティは、オブジェクトがインストールされた日時を示す値です。

 

Returns:

  • (datetime)

    InstallDate



167
168
169
# File 'lib/CIM_AlarmDevice.rb', line 167

def InstallDate
  @InstallDate
end

- (uint32) LastErrorCode (readonly)

論理デバイスで報告されたエラー コードが LastErrorCode によってキャプチャされます。

Returns:

  • (uint32)

    LastErrorCode



172
173
174
# File 'lib/CIM_AlarmDevice.rb', line 172

def LastErrorCode
  @LastErrorCode
end

- (string) Name (readonly)

Name プロパティで、オブジェクトを認識するラベルを定義します。

 

Returns:

  • (string)

    Name



178
179
180
# File 'lib/CIM_AlarmDevice.rb', line 178

def Name
  @Name
end

- (string) PNPDeviceID (readonly)

論理デバイスの Win32 プラグ アンド プレイ デバイス ID を示します。

 

Returns:

  • (string)

    PNPDeviceID



184
185
186
# File 'lib/CIM_AlarmDevice.rb', line 184

def PNPDeviceID
  @PNPDeviceID
end

- (uint16) PowerManagementCapabilities (readonly)

論理デバイスの特定の電源関連機能を示します。

 0="不明"

Returns:

  • (uint16)

    PowerManagementCapabilities



195
196
197
# File 'lib/CIM_AlarmDevice.rb', line 195

def PowerManagementCapabilities
  @PowerManagementCapabilities
end

- (boolean) PowerManagementSupported (readonly)

デバイスを電源管理できることを示すブール値です - 例、省電力状態にする。

 

Returns:

  • (boolean)

    PowerManagementSupported



203
204
205
# File 'lib/CIM_AlarmDevice.rb', line 203

def PowerManagementSupported
  @PowerManagementSupported
end

- (string) Status (readonly)

Status プロパティはオブジェクトの現在の状態を示す文字列です。

 

Returns:

  • (string)

    Status



216
217
218
# File 'lib/CIM_AlarmDevice.rb', line 216

def Status
  @Status
end

- (uint16) StatusInfo (readonly)

StatusInfo は、論理デバイスが有効 (値 = 3)、無効 (値 = 4) またはその他 (1) または不明 (2) 状態であるかどうかを示す文字列です。

 

Returns:

  • (uint16)

    StatusInfo



222
223
224
# File 'lib/CIM_AlarmDevice.rb', line 222

def StatusInfo
  @StatusInfo
end

- (string) SystemCreationClassName (readonly)

スコーピング システムの CreationClassName です。

Returns:

  • (string)

    SystemCreationClassName



228
229
230
# File 'lib/CIM_AlarmDevice.rb', line 228

def SystemCreationClassName
  @SystemCreationClassName
end

- (string) SystemName (readonly)

スコーピング システムの名前です。

Returns:

  • (string)

    SystemName



233
234
235
# File 'lib/CIM_AlarmDevice.rb', line 233

def SystemName
  @SystemName
end

- (uint16) Urgency (readonly)

緊急性は警告が点滅したり、振動したり、または音を出す相対的周波数を示す列挙された値です。

Returns:

  • (uint16)

    Urgency



238
239
240
# File 'lib/CIM_AlarmDevice.rb', line 238

def Urgency
  @Urgency
end

- (boolean) VisibleAlarm (readonly)

アラームが可視であることを示すブール値です。

Returns:

  • (boolean)

    VisibleAlarm



243
244
245
# File 'lib/CIM_AlarmDevice.rb', line 243

def VisibleAlarm
  @VisibleAlarm
end

Instance Method Details

- (uint32) Reset

論理デバイスのリセットを要求します。 要求が正常に実行された場合、返される値は 0 で、要求がサポートされない場合は 1 です。 また、エラーが発生した場合は、ほかの値となります。

Returns:

  • (uint32)


25
26
# File 'lib/CIM_AlarmDevice.rb', line 25

def Reset 
end

- (uint32) SetPowerState(PowerState, Time)

SetPowerState により、論理デバイスの電源状態およびデバイスがいつその状態に入るかが定義されます。 電源状態は、PowerState パラメータを次の整数値の 1 つに設定することによって指定されます: 1="通常の電力"、2="省電力- 低電力モード"、3="省電力 - スタンバイ"、4="省電力 - その他"、5="電源サイクル" または 6="電源オフ"。 時間パラメータ (5 の "Power Cycle" を除くすべての状態の変更用) は、通常の日付値または間隔値 (メソッド実行の受信時に間隔が開始される) のどちらかにいつ電源状態が設定される必要があるかを示します。 PowerState パラメータが 5 ("Power Cycle") であるとき、時間パラメータはいつデバイスが再度電源オンになるかを示します。 直ちに電源をオフにします。 成功の場合、SetPowerState は 0 を返し、指定された PowerState および要求時間がサポートされていない場合は、1 を返し、ほかのエラーが発生する場合はほかの値が返されます。 サブクラスでは、可能な返信コードのセットはメソッド上の ValueMap 修飾子を使って指定することも可能です。

 ValueMap 

値の配置修飾子としてサブクラスで指定される場合もあります。

Parameters:

  • (uint16, #read) PowerState
  • (datetime, #read) Time

Returns:

  • (uint32)


17
18
# File 'lib/CIM_AlarmDevice.rb', line 17

def SetPowerState PowerState, Time
end

- (uint32) SetUrgency(RequestedUrgency)

SetUrgency は、アラームに要求された緊急性レベルを定義付ける方法です。 入力パラメータ RequestedUrgency は、CIM_AlarmDevice の Urgency プロパティの、値一覧を使って指定されます。 SetUrgency により、要求が正常に実装される場合は、0 が返され、指定の緊急レベルがサポートされない場合は 1 が返され、ほかのエラーが発生する場合はほかの値が返されます。

Parameters:

  • (uint16, #read) RequestedUrgency

Returns:

  • (uint32)


34
35
# File 'lib/CIM_AlarmDevice.rb', line 34

def SetUrgency RequestedUrgency
end