Class: WMI::CIM_DiscreteSensor

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

Overview

DiscreteSensor には、報告が可能な正しい文字列値のセットがあります。これらの値はセンサーの PossibleValues プロパティに列挙されています。DiscreteSensor には、列挙される値の 1 つに対応する ’現在の読み取り’ が常にあります。 CurrentState および PossibleStates プロパティのセンサへの追加により、DiscreteSensor サブクラスはもう必要ありませんが、バックワード互換性のために維持されます。CurrentReading および PossibleValues プロパティの情報は、通常、センサから継承した CurrentState および PossibleStates プロパティと同じ値および語義を持ちます。

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

- (STRING) AcceptableValues (readonly)

AcceptableValues プロパティにより、PossibleValues プロパティのどの文字列が ‘acceptable’ (つまり、’not an error’) であるかどうかが詳しく示されます。

Returns:

  • (STRING)

    AcceptableValues



32
33
34
# File 'lib/CIM_DiscreteSensor.rb', line 32

def AcceptableValues
  @AcceptableValues
end

- (uint16) Availability (readonly)

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

 

Returns:

  • (uint16)

    Availability



42
43
44
# File 'lib/CIM_DiscreteSensor.rb', line 42

def Availability
  @Availability
end

- (string) Caption (readonly)

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

Returns:

  • (string)

    Caption



47
48
49
# File 'lib/CIM_DiscreteSensor.rb', line 47

def Caption
  @Caption
end

- (uint32) ConfigManagerErrorCode (readonly)

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

 

Returns:

  • (uint32)

    ConfigManagerErrorCode



120
121
122
# File 'lib/CIM_DiscreteSensor.rb', line 120

def ConfigManagerErrorCode
  @ConfigManagerErrorCode
end

- (boolean) ConfigManagerUserConfig (readonly)

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

Returns:

  • (boolean)

    ConfigManagerUserConfig



125
126
127
# File 'lib/CIM_DiscreteSensor.rb', line 125

def ConfigManagerUserConfig
  @ConfigManagerUserConfig
end

- (string) CreationClassName (readonly)

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

 

Returns:

  • (string)

    CreationClassName



131
132
133
# File 'lib/CIM_DiscreteSensor.rb', line 131

def CreationClassName
  @CreationClassName
end

- (STRING) CurrentReading (readonly)

センサが示す現在の値です。

Returns:

  • (STRING)

    CurrentReading



136
137
138
# File 'lib/CIM_DiscreteSensor.rb', line 136

def CurrentReading
  @CurrentReading
end

- (string) Description (readonly)

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

Returns:

  • (string)

    Description



142
143
144
# File 'lib/CIM_DiscreteSensor.rb', line 142

def Description
  @Description
end

- (string) DeviceID (readonly)

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

Returns:

  • (string)

    DeviceID



147
148
149
# File 'lib/CIM_DiscreteSensor.rb', line 147

def DeviceID
  @DeviceID
end

- (boolean) ErrorCleared (readonly)

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

Returns:

  • (boolean)

    ErrorCleared



152
153
154
# File 'lib/CIM_DiscreteSensor.rb', line 152

def ErrorCleared
  @ErrorCleared
end

- (string) ErrorDescription (readonly)

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

Returns:

  • (string)

    ErrorDescription



157
158
159
# File 'lib/CIM_DiscreteSensor.rb', line 157

def ErrorDescription
  @ErrorDescription
end

- (datetime) InstallDate (readonly)

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

 

Returns:

  • (datetime)

    InstallDate



163
164
165
# File 'lib/CIM_DiscreteSensor.rb', line 163

def InstallDate
  @InstallDate
end

- (uint32) LastErrorCode (readonly)

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

Returns:

  • (uint32)

    LastErrorCode



168
169
170
# File 'lib/CIM_DiscreteSensor.rb', line 168

def LastErrorCode
  @LastErrorCode
end

- (string) Name (readonly)

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

 

Returns:

  • (string)

    Name



174
175
176
# File 'lib/CIM_DiscreteSensor.rb', line 174

def Name
  @Name
end

- (string) PNPDeviceID (readonly)

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

 

Returns:

  • (string)

    PNPDeviceID



180
181
182
# File 'lib/CIM_DiscreteSensor.rb', line 180

def PNPDeviceID
  @PNPDeviceID
end

- (STRING) PossibleValues (readonly)

PossibleValues プロパティにより、別個のセンサによって出力される文字列出力が列挙されます。

Returns:

  • (STRING)

    PossibleValues



185
186
187
# File 'lib/CIM_DiscreteSensor.rb', line 185

def PossibleValues
  @PossibleValues
end

- (uint16) PowerManagementCapabilities (readonly)

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

 0="不明"

Returns:

  • (uint16)

    PowerManagementCapabilities



196
197
198
# File 'lib/CIM_DiscreteSensor.rb', line 196

def PowerManagementCapabilities
  @PowerManagementCapabilities
end

- (boolean) PowerManagementSupported (readonly)

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

 

Returns:

  • (boolean)

    PowerManagementSupported



204
205
206
# File 'lib/CIM_DiscreteSensor.rb', line 204

def PowerManagementSupported
  @PowerManagementSupported
end

- (string) Status (readonly)

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

 

Returns:

  • (string)

    Status



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

def Status
  @Status
end

- (uint16) StatusInfo (readonly)

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

 

Returns:

  • (uint16)

    StatusInfo



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

def StatusInfo
  @StatusInfo
end

- (string) SystemCreationClassName (readonly)

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

Returns:

  • (string)

    SystemCreationClassName



229
230
231
# File 'lib/CIM_DiscreteSensor.rb', line 229

def SystemCreationClassName
  @SystemCreationClassName
end

- (string) SystemName (readonly)

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

Returns:

  • (string)

    SystemName



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

def SystemName
  @SystemName
end

Instance Method Details

- (uint32) Reset

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

Returns:

  • (uint32)


26
27
# File 'lib/CIM_DiscreteSensor.rb', line 26

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)


18
19
# File 'lib/CIM_DiscreteSensor.rb', line 18

def SetPowerState PowerState, Time
end