version 1.1, 2006/10/30 13:02:53
|
version 1.2, 2006/11/10 18:14:58
|
|
|
#include <Pegasus/Common/CIMInstance.h> | #include <Pegasus/Common/CIMInstance.h> |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
/* PropertyAccessor is a set of support functions for property value access within instances. |
/* |
These functions provide the capability to get and set the value of all of the |
PropertyAccessor is a set of support functions for property value access |
native property types within Pegasus using only the reference to the instance and |
within instances. These functions provide the capability to get and set |
the property name as identifiers. The provide, in effect, an associative link to |
the value of all of the native property types within Pegasus using only |
property values as an alternate to the index based reference defined in the CIMInstance |
the reference to the instance and the property name as identifiers. They |
object. Further, they allow directly getting and setting the value in place of the |
provide, in effect, an associative link to property values as an |
multistep approach in the objects where the the CIMValue must first be retrieved before |
alternate to the index based reference defined in the CIMInstance |
the value can be accessed. This reduces the access to a single line of code. |
object. Further, they allow directly getting and setting the value in |
|
place of the multistep approach in the objects where the the CIMValue |
|
must first be retrieved before the value can be accessed. This reduces |
|
the access to a single line of code. |
|
|
|
These functions assume that the property exists in the instance. |
| |
These functions assume that the property exists in the instance and execute a |
|
Examples: | Examples: |
Set(_inst, "ErrorSourceFormat", Uint16(value), null); | Set(_inst, "ErrorSourceFormat", Uint16(value), null); |
bool nullStat = Get(_inst, "ErrorSourceFormat", t); | bool nullStat = Get(_inst, "ErrorSourceFormat", t); |
|
|
variable if the NULL attribute is NOT set for the CIMValue for this | variable if the NULL attribute is NOT set for the CIMValue for this |
property. | property. |
@return bool returns true if the CIMValue for the property is NOT Null. | @return bool returns true if the CIMValue for the property is NOT Null. |
@exception Returns CIM_ERR_NO_SUCH_PROPERTY if the named property is not in the |
@exception Returns CIM_ERR_NO_SUCH_PROPERTY if the named property is not |
instance. |
in the instance. |
*/ | */ |
bool Get( | bool Get( |
const CIMInstance& inst, | const CIMInstance& inst, |
|
|
@param null bool If this is set true, the value parameter is ignored and the | @param null bool If this is set true, the value parameter is ignored and the |
property is set to NULL. | property is set to NULL. |
@return bool returns true if the CIMValue for the property is NOT Null. | @return bool returns true if the CIMValue for the property is NOT Null. |
@exception Returns CIM_ERR_NO_SUCH_PROPERTY if the named property is not in the |
@exception Returns CIM_ERR_NO_SUCH_PROPERTY if the named property is not |
instance. |
in the instance. |
*/ | */ |
void Set( | void Set( |
CIMInstance& inst, | CIMInstance& inst, |