CIMKeyBinding Class Reference
#include <CIMObjectPath.h>
Public Types
enum Type { BOOLEAN, STRING, NUMERIC, REFERENCE } Public Member Functions
CIMKeyBinding () CIMKeyBinding (const CIMKeyBinding &x) CIMKeyBinding (const CIMName &name, const String &value, Type type) CIMKeyBinding (const CIMName &name, const CIMValue &value) ~CIMKeyBinding () CIMKeyBinding & operator= (const CIMKeyBinding &x) const CIMName & getName () const void setName (const CIMName &name) const String & getValue () const void setValue (const String &value) Type getType () const void setType (Type type) Boolean equal (CIMValue value) Detailed Description
The CIMKeyBinding class associates a key name, value, and type. It is used to represent a key binding in a CIMObjectPath.
Member Enumeration Documentation
enum CIMKeyBinding::Type The CIMKeyBinding Type corresponds to the CIM-XML key binding definition, in which the CIMType values are mapped into categories.
- Enumerator:
BOOLEAN Boolean type
STRING String, Char16, and CIMDateTime types
NUMERIC Integer and real number types
REFERENCE CIMObjectPath (reference) type
Constructor & Destructor Documentation
Constructs a CIMKeyBinding object with null values.
CIMKeyBinding::CIMKeyBinding ( const CIMKeyBinding & x ) Constructs a CIMKeyBinding object from the value of a specified CIMKeyBinding object.
- Parameters:
x The CIMKeyBinding object from which to construct a new CIMKeyBinding object.
CIMKeyBinding::CIMKeyBinding ( const CIMName & name, const String & value, Type type ) Constructs a CIMKeyBinding with a name, value, and type.
- Parameters:
name A CIMName containing the key name. value A String value for this key. type A CIMKeyBinding::Type specifying the type of this key.
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 - REFERENCEA 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:
TypeMismatchException If the type is not a valid key type, false otherwise. Destructs the CIMKeyBinding object.
Member Function Documentation
Boolean CIMKeyBinding::equal ( CIMValue value )
const CIMName& CIMKeyBinding::getName ( ) const Gets the key name for the key binding.
- Returns:
- A CIMName containing the key name.
Type CIMKeyBinding::getType ( ) const Gets the key type for the key binding.
- Returns:
- A CIMKeyBinding::Type containing the key type.
const String& CIMKeyBinding::getValue ( ) const Gets the key value for the key binding.
- Returns:
- A String containing the key value.
CIMKeyBinding& CIMKeyBinding::operator= ( const CIMKeyBinding & x ) Assigns the value of the specified CIMKeyBinding object to this object.
- Parameters:
x The CIMKeyBinding object from which to assign this CIMKeyBinding object.
- Returns:
- A reference to this CIMKeyBinding object.
void CIMKeyBinding::setName ( const CIMName & name ) Sets the key name for the key binding.
- Parameters:
name A CIMName containing the key name.
void CIMKeyBinding::setType ( Type type ) Sets the key type for the key binding.
- Parameters:
type A CIMKeyBinding::Type containing the key type.
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:
- /var/tmp/tog-pegasus-2.9.0-8m.mo8/pegasus/src/Pegasus/Common/CIMObjectPath.h