#include <CIMObjectPath.h>
The CIMKeyBinding class associates a key name, value, and type. It is used to represent a key binding in a CIMObjectPath.
◆ Type
The CIMKeyBinding Type corresponds to the CIM-XML key binding definition, in which the CIMType values are mapped into categories.
◆ CIMKeyBinding() [1/4]
CIMKeyBinding::CIMKeyBinding |
( |
| ) |
|
◆ CIMKeyBinding() [2/4]
◆ CIMKeyBinding() [3/4]
CIMKeyBinding::CIMKeyBinding |
( |
const CIMName & |
name, |
|
|
const String & |
value, |
|
|
Type |
type |
|
) |
| |
Constructs a CIMKeyBinding with a name, value, and type.
- Parameters
-
◆ CIMKeyBinding() [4/4]
CIMKeyBinding::CIMKeyBinding |
( |
const CIMName & |
name, |
|
|
const CIMValue & |
value |
|
) |
| |
Constructs a CIMKeyBinding with a key name and CIMValue. The key value and type are taken from the CIMValue. CIM types are converted to key binding types using this mapping:
boolean - BOOLEAN
uint8 - NUMERIC
sint8 - NUMERIC
uint16 - NUMERIC
sint16 - NUMERIC
uint32 - NUMERIC
sint32 - NUMERIC
uint64 - NUMERIC
sint64 - NUMERIC
real32 - NUMERIC
real64 - NUMERIC
char16 - STRING
string - STRING
datetime - STRING
reference - REFERENCE
A value of type CIMTYPE_OBJECT cannot be used in a key binding.
- Parameters
-
name | A CIMName containing the key name. |
value | A CIMValue specifying the value and type of this key. |
- Exceptions
-
◆ ~CIMKeyBinding()
CIMKeyBinding::~CIMKeyBinding |
( |
| ) |
|
◆ equal()
Boolean CIMKeyBinding::equal |
( |
CIMValue |
value | ) |
|
Compares the value and type of the key binding with a specified CIMValue.
- Parameters
-
- Returns
- True if the value and type of the key binding are the same as the specified CIMValue, false otherwise.
◆ getName()
const CIMName& CIMKeyBinding::getName |
( |
| ) |
const |
Gets the key name for the key binding.
- Returns
- A CIMName containing the key name.
◆ getType()
Type CIMKeyBinding::getType |
( |
| ) |
const |
◆ getValue()
const String& CIMKeyBinding::getValue |
( |
| ) |
const |
Gets the key value for the key binding.
- Returns
- A String containing the key value.
◆ operator=()
Assigns the value of the specified CIMKeyBinding object to this object.
- Parameters
-
- Returns
- A reference to this CIMKeyBinding object.
◆ setName()
void CIMKeyBinding::setName |
( |
const CIMName & |
name | ) |
|
Sets the key name for the key binding.
- Parameters
-
name | A CIMName containing the key name. |
◆ setType()
void CIMKeyBinding::setType |
( |
Type |
type | ) |
|
Sets the key type for the key binding.
- Parameters
-
◆ setValue()
void CIMKeyBinding::setValue |
( |
const String & |
value | ) |
|
Sets the key value for the key binding.
- Parameters
-
value | A String containing the key value. |
The documentation for this class was generated from the following file: