CIM_SettingsDefineCapabilities class
This association indicates that the non-null, non-key set of properties of the component SettingData instance specifies some capabilities of the associated Capabilities instance. The interpretation of the set of properties in the associated SettingData is governed by the properties: PropertyPolicy and ValueRole. For a particular Capabilities instance, the complete set of Component SettingData instances, together with properties of the Capabilities instance itself, defines the overall range of supported capabilities. PropertyPolicy determines whether the properties of the set are interpreted independently or as a whole (that is, correlated). ValueRole further qualifies the members of the set. This association eliminates the need to define and maintain corresponding property definitions and values in both a Capabilities subclass and a SettingData subclass. Typically these setting instances will be published along with the associated Capabilities instance and will not be modifiable by the client.
Important The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
class CIM_SettingsDefineCapabilities : CIM_Component
{
CIM_Capabilities REF GroupComponent;
CIM_SettingData REF PartComponent;
uint16 PropertyPolicy = 0;
uint16 ValueRole = 3;
uint16 ValueRange = 0;
};
Members
The CIM_SettingsDefineCapabilities class has these types of members:
- Properties
Properties
The CIM_SettingsDefineCapabilities class has these properties.
GroupComponent
Data type: CIM_Capabilities
Access type: Read-only
Qualifiers: Override, Max ( 1)
The Capabilities instance.
PartComponent
Data type: CIM_SettingData
Access type: Read-only
A setting used to define the associated Capabilities instance.
PropertyPolicy
Data type: uint16
Access type: Read-only
Defines whether or not the non-null, non-key properties of the associated SettingData instance are handled independently or as a correlated set. For example, an independent set of maximum properties might be defined, when there is no relationship between each property. Conversely, several correlated sets of maximum properties might need to be defined when the maximum values of each are dependent on others.
Independent (0)
Correlated (1)
DMTF Reserved (2..)
ValueRange
Data type: uint16
Access type: Read-only
Indicates further semantics on the interpretation of all non-null, non-key properties of the Component SettingData. For the associated Capabilities, if an evaluated property currently has no corresponding minimums or maximums, then the property has no affect. Otherwise, for each evaluated property: its value x shall be between the minimum and maximum, inclusively, and shall have the property that both the result of maximum minus x and the result of x minus minimum are each an integer multiple of the increment. If either minimum or maximum is not specified and the other is, then the missing value shall be respectively assumed to be the lowest or highest supported value for the property data-type. In addition, if both a minimum and a maximum are specified for an evaluated property, then the result of maximum minus minimum shall be an integer multiple of the increment.
| Value | Meaning |
|---|---|
| Point 0 | This SettingData instance provides a single set of values. "Minimums", "Maximums", and "Increments", are only evaluated against non-null, non-key, non-enumerated, non-Boolean, numeric properties of the SettingData instance. Each property of that set shall be mathematically comparable to other instances of that property. |
| Minimums 1 | This SettingData instance provides minimum values for evaluated properties. When used with PropertyPolicy = "Independent", only one such setting per particular SettingData instance shall be specified for any Capabilities. Unless restricted by a Maximums on the same set of properties, all values that compare higher than the specified values are also considered to be supported by the associated capabilities instance. |
| Maximums 2 | This SettingData instance provides maximum values for evaluated properties. When used with PropertyPolicy = "Independent", only one such setting per particular SettingData instance shall be specified for any Capabilities. Unless restricted by a Minimums on the same set of properties, all values that compare lower than the specified values are also considered to be supported by the associated capabilities instance. |
| Increments 3 | This SettingData instance provides increment values for evaluated properties. |
| DMTF Reserved 4.. |
ValueRole
Data type: uint16
Access type: Read-only
Indicates further semantics on the interpretation of the non-null, non-key properties of the Component SettingData.
| Value | Meaning |
|---|---|
| Default 0 | The property values of the component SettingData instance will be used as default values, when a new SettingData instance is created for elements whose capabilities are defined by the associated Capabilities instance. Across instances of settingdata, for particular properties having the same semantic purpose, at most one such settingdata instance shall be specified as a default. |
| Optimal 1 | The SettingData instance represents optimal setting values for elements associated with the associated capabilities instance. Multiple component SettingData instances may be declared as optimal. |
| Mean 2 | The non-null, non-key, non-enumerated, non-Boolean, numeric properties of the associated SettingData instance represents an average point along some dimension. For different combinations of SettingData properties, multiple component SettingData instances may be declared as "Mean". |
| Supported 3 | The non-null, non-key properties of the Component SettingData instance represents a set of supported property values that are not otherwise qualified. |
| DMTF Reserved 4.. | Reserved. |
Requirements
Namespace |
Root\CIMV2 |