CIMParamValue Class Reference
#include <CIMParamValue.h>
List of all members.
Detailed Description
The CIMParamValue class represents an extrinsic method parameter value, as defined in the DMTF Specification for CIM Operations over HTTP.
The CIMParamValue class uses a shared representation model, such that multiple CIMParamValue objects may refer to the same data copy. Assignment and copy operators create new references to the same data, not distinct copies. An update to a CIMParamValue object affects all the CIMParamValue objects that refer to the same data copy. The data remains valid until all the CIMParamValue objects that refer to it are destructed. A separate copy of the data may be created using the clone method.
Constructor & Destructor Documentation
CIMParamValue::CIMParamValue |
( |
|
) |
|
Constructs an uninitialized CIMParamValue object. A method invocation on an uninitialized object will result in the throwing of an UninitializedObjectException. An uninitialized object may be converted into an initialized object only by using the assignment operator with an initialized object.
Constructs a CIMParamValue object from the value of a specified CIMParamValue object, so that both objects refer to the same data copy.
- Parameters:
-
CIMParamValue::CIMParamValue |
( |
String |
parameterName, |
|
|
CIMValue |
value, |
|
|
Boolean |
isTyped = true | |
|
) |
| | |
Constructs a parameter value with the specified attributes.
- Parameters:
-
| parameterName | A String containing the name of this parameter. |
| value | A CIMValue containing the value of this parameter. |
| isTyped | A Boolean indicating whether the type indicated in the value is correct. This is needed because the Specification for the Representation of CIM in XML does not require type information to be specified with a parameter value. |
- Exceptions:
-
CIMParamValue::~CIMParamValue |
( |
|
) |
|
Member Function Documentation
Makes a deep copy of the object. This creates a new copy of all the object attributes.
- Returns:
- A new copy of the CIMParamValue object.
- Exceptions:
-
String CIMParamValue::getParameterName |
( |
|
) |
const |
Gets the parameter name for the parameter value.
- Returns:
- A String containing the parameter name.
- Exceptions:
-
CIMValue CIMParamValue::getValue |
( |
|
) |
const |
Gets the value for the parameter.
- Returns:
- A CIMValue containing the parameter value.
- Exceptions:
-
Boolean CIMParamValue::isTyped |
( |
|
) |
const |
Checks whether the parameter value has the correct type.
- Returns:
- True if the parameter value is known to have the correct type, false otherwise.
- Exceptions:
-
Boolean CIMParamValue::isUninitialized |
( |
|
) |
const |
Determines whether the object has been initialized.
- Returns:
- True if the object has not been initialized, false otherwise.
Assigns the value of the specified CIMParamValue object to this object, so that both objects refer to the same data copy.
- Parameters:
-
- Returns:
- A reference to this CIMParamValue object.
void CIMParamValue::setIsTyped |
( |
Boolean |
isTyped |
) |
|
Sets a flag indicating whether the parameter value has the correct type.
- Parameters:
-
| isTyped | A Boolean indicating whether the parameter value is known to have the correct type. |
- Exceptions:
-
void CIMParamValue::setParameterName |
( |
String & |
parameterName |
) |
|
Sets the parameter name for the parameter value.
- Parameters:
-
| parameterName | A String containing the parameter name. |
- Exceptions:
-
void CIMParamValue::setValue |
( |
CIMValue & |
value |
) |
|
Sets the value for the parameter.
- Parameters:
-
| value | A CIMValue containing the parameter value. |
- Exceptions:
-
The documentation for this class was generated from the following file: