Class: WMI::CIM_Battery

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

Overview

バッテリ論理デバイスの機能と管理です。このクラスはラップトップ システムおよび UPS などのほかの内部/外部バッテリの両方に適用されます。

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

- (uint16) Availability (readonly)

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

 

Returns:

  • (uint16)

    Availability



36
37
38
# File 'lib/CIM_Battery.rb', line 36

def Availability
  @Availability
end

- (uint16) BatteryStatus (readonly)

バッテリの充電状態を示します。

 "充電完了" (

Returns:

  • (uint16)

    BatteryStatus



44
45
46
# File 'lib/CIM_Battery.rb', line 44

def BatteryStatus
  @BatteryStatus
end

- (string) Caption (readonly)

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

Returns:

  • (string)

    Caption



49
50
51
# File 'lib/CIM_Battery.rb', line 49

def Caption
  @Caption
end

- (uint16) Chemistry (readonly)

バッテリの特質を示す列挙です。

Returns:

  • (uint16)

    Chemistry



54
55
56
# File 'lib/CIM_Battery.rb', line 54

def Chemistry
  @Chemistry
end

- (uint32) ConfigManagerErrorCode (readonly)

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

 

Returns:

  • (uint32)

    ConfigManagerErrorCode



127
128
129
# File 'lib/CIM_Battery.rb', line 127

def ConfigManagerErrorCode
  @ConfigManagerErrorCode
end

- (boolean) ConfigManagerUserConfig (readonly)

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

Returns:

  • (boolean)

    ConfigManagerUserConfig



132
133
134
# File 'lib/CIM_Battery.rb', line 132

def ConfigManagerUserConfig
  @ConfigManagerUserConfig
end

- (string) CreationClassName (readonly)

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

 

Returns:

  • (string)

    CreationClassName



138
139
140
# File 'lib/CIM_Battery.rb', line 138

def CreationClassName
  @CreationClassName
end

- (string) Description (readonly)

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

Returns:

  • (string)

    Description



144
145
146
# File 'lib/CIM_Battery.rb', line 144

def Description
  @Description
end

- (uint32) DesignCapacity (readonly)

ミリワット時単位のバッテリのデザイン容量です。

 

Returns:

  • (uint32)

    DesignCapacity



150
151
152
# File 'lib/CIM_Battery.rb', line 150

def DesignCapacity
  @DesignCapacity
end

- (uint64) DesignVoltage (readonly)

ミリボルト単位のバッテリのデザイン電圧です。

 

Returns:

  • (uint64)

    DesignVoltage



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

def DesignVoltage
  @DesignVoltage
end

- (string) DeviceID (readonly)

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

Returns:

  • (string)

    DeviceID



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

def DeviceID
  @DeviceID
end

- (boolean) ErrorCleared (readonly)

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

Returns:

  • (boolean)

    ErrorCleared



166
167
168
# File 'lib/CIM_Battery.rb', line 166

def ErrorCleared
  @ErrorCleared
end

- (string) ErrorDescription (readonly)

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

Returns:

  • (string)

    ErrorDescription



171
172
173
# File 'lib/CIM_Battery.rb', line 171

def ErrorDescription
  @ErrorDescription
end

- (uint16) EstimatedChargeRemaining (readonly)

完全に充電するための残りのパーセントを予想します。

Returns:

  • (uint16)

    EstimatedChargeRemaining



176
177
178
# File 'lib/CIM_Battery.rb', line 176

def EstimatedChargeRemaining
  @EstimatedChargeRemaining
end

- (uint32) EstimatedRunTime (readonly)

EstimatedRunTime は、ユーティリティ電力がオフになっているか、電力がない状態になっている、またはラップトップが電源につながっていない場合、現在のロード状態でのバッテリの消耗予想時間 (分) です。

Returns:

  • (uint32)

    EstimatedRunTime



181
182
183
# File 'lib/CIM_Battery.rb', line 181

def EstimatedRunTime
  @EstimatedRunTime
end

- (uint32) ExpectedLife (readonly)

バッテリが完全に充電されているとして、バッテリの寿命の予想時間を分で示します。

 

Returns:

  • (uint32)

    ExpectedLife



187
188
189
# File 'lib/CIM_Battery.rb', line 187

def ExpectedLife
  @ExpectedLife
end

- (uint32) FullChargeCapacity (readonly)

バッテリの完全充電の容量 (ミリワット時単位) この値と DesignCapacity プロパティを比較することで、バッテリの交換が必要となるときが決定されます。

 

Returns:

  • (uint32)

    FullChargeCapacity



194
195
196
# File 'lib/CIM_Battery.rb', line 194

def FullChargeCapacity
  @FullChargeCapacity
end

- (datetime) InstallDate (readonly)

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

 

Returns:

  • (datetime)

    InstallDate



200
201
202
# File 'lib/CIM_Battery.rb', line 200

def InstallDate
  @InstallDate
end

- (uint32) LastErrorCode (readonly)

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

Returns:

  • (uint32)

    LastErrorCode



205
206
207
# File 'lib/CIM_Battery.rb', line 205

def LastErrorCode
  @LastErrorCode
end

- (uint32) MaxRechargeTime (readonly)

MaxRechargeTime はバッテリを完全に充電するための最長時間 (分) を示します。

 

Returns:

  • (uint32)

    MaxRechargeTime



211
212
213
# File 'lib/CIM_Battery.rb', line 211

def MaxRechargeTime
  @MaxRechargeTime
end

- (string) Name (readonly)

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

 

Returns:

  • (string)

    Name



217
218
219
# File 'lib/CIM_Battery.rb', line 217

def Name
  @Name
end

- (string) PNPDeviceID (readonly)

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

 

Returns:

  • (string)

    PNPDeviceID



223
224
225
# File 'lib/CIM_Battery.rb', line 223

def PNPDeviceID
  @PNPDeviceID
end

- (uint16) PowerManagementCapabilities (readonly)

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

 0="不明"

Returns:

  • (uint16)

    PowerManagementCapabilities



234
235
236
# File 'lib/CIM_Battery.rb', line 234

def PowerManagementCapabilities
  @PowerManagementCapabilities
end

- (boolean) PowerManagementSupported (readonly)

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

 

Returns:

  • (boolean)

    PowerManagementSupported



242
243
244
# File 'lib/CIM_Battery.rb', line 242

def PowerManagementSupported
  @PowerManagementSupported
end

- (string) SmartBatteryVersion (readonly)

このバッテリにサポートされる Smart Battery Data Specification バージョン番号です。

 

Returns:

  • (string)

    SmartBatteryVersion



248
249
250
# File 'lib/CIM_Battery.rb', line 248

def SmartBatteryVersion
  @SmartBatteryVersion
end

- (string) Status (readonly)

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

 

Returns:

  • (string)

    Status



261
262
263
# File 'lib/CIM_Battery.rb', line 261

def Status
  @Status
end

- (uint16) StatusInfo (readonly)

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

 

Returns:

  • (uint16)

    StatusInfo



267
268
269
# File 'lib/CIM_Battery.rb', line 267

def StatusInfo
  @StatusInfo
end

- (string) SystemCreationClassName (readonly)

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

Returns:

  • (string)

    SystemCreationClassName



273
274
275
# File 'lib/CIM_Battery.rb', line 273

def SystemCreationClassName
  @SystemCreationClassName
end

- (string) SystemName (readonly)

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

Returns:

  • (string)

    SystemName



278
279
280
# File 'lib/CIM_Battery.rb', line 278

def SystemName
  @SystemName
end

- (uint32) TimeOnBattery (readonly)

TimeOnBattery は、コンピュータ システムの UPS がバッテリ電源に最後に切り替わったときからの経過時間 (秒)か、システムまたは UPS が最後に再起動したときの時間を示します。

 

Returns:

  • (uint32)

    TimeOnBattery



284
285
286
# File 'lib/CIM_Battery.rb', line 284

def TimeOnBattery
  @TimeOnBattery
end

- (uint32) TimeToFullCharge (readonly)

現在の充電レートと使用で、バッテリを完全に充電するまでの残り時間 (分) です。

Returns:

  • (uint32)

    TimeToFullCharge



289
290
291
# File 'lib/CIM_Battery.rb', line 289

def TimeToFullCharge
  @TimeToFullCharge
end

Instance Method Details

- (uint32) Reset

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

Returns:

  • (uint32)


25
26
# File 'lib/CIM_Battery.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_Battery.rb', line 17

def SetPowerState PowerState, Time
end