CIMClass Class Reference
#include <CIMClass.h>
List of all members.
Detailed Description
The CIMClass class represents the DMTF standard CIM class definition.
The CIMClass class uses a shared representation model, such that multiple CIMClass 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 CIMClass object affects all the CIMClass objects that refer to the same data copy. The data remains valid until all the CIMClass objects that refer to it are destructed. A separate copy of the data may be created using the clone method.
Constructor & Destructor Documentation
Constructs an uninitialized CIMClass 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.
CIMClass::CIMClass |
( |
const CIMClass & |
x |
) |
|
Constructs a CIMClass object from the value of a specified CIMClass object, so that both objects refer to the same data copy.
- Parameters:
-
CIMClass::CIMClass |
( |
const CIMObject & |
x |
) |
[explicit] |
Constructs a CIMClass object from the value of a specified CIMObject object, so that both objects refer to the same data copy.
- Parameters:
-
- Exceptions:
-
Constructs a CIMClass object with the specified attributes.
Example:
CIMClass NewClass("MyClass", "YourClass");
- Parameters:
-
| className | A CIMName specifying the name of the class. |
| superClassName | A CIMName specifying name of the parent class. (A null value indicates no superclass.) |
Member Function Documentation
Adds a method to the class.
- Parameters:
-
- Returns:
- A reference to this CIMClass object.
- Exceptions:
-
Adds a property to the class.
- Parameters:
-
- Returns:
- A reference to this CIMClass object.
- Exceptions:
-
Adds a qualifier to the class.
- Parameters:
-
- Returns:
- A reference to this CIMClass object.
- Exceptions:
-
Makes a deep copy of the class. This creates a new copy of all the class attributes including qualifiers, properties, and methods.
- Returns:
- A new copy of the CIMClass object.
- Exceptions:
-
Uint32 CIMClass::findMethod |
( |
const CIMName & |
name |
) |
const |
Finds a method by name.
- Parameters:
-
| name | A CIMName specifying the name of the method to be found. |
- Returns:
- Index of the method if found or PEG_NOT_FOUND if not found.
- Exceptions:
-
Uint32 CIMClass::findProperty |
( |
const CIMName & |
name |
) |
const |
Finds a property by name.
- Parameters:
-
| name | A CIMName specifying the name of the property to be found. |
- Returns:
- Index of the property if found or PEG_NOT_FOUND if not found.
- Exceptions:
-
Uint32 CIMClass::findQualifier |
( |
const CIMName & |
name |
) |
const |
Finds a qualifier by name.
- Parameters:
-
| name | A CIMName specifying the name of the qualifier to be found. |
- Returns:
- Index of the qualifier if found or PEG_NOT_FOUND if not found.
- Exceptions:
-
const CIMName& CIMClass::getClassName |
( |
|
) |
const |
Gets the name of the class.
- Returns:
- A CIMName containing the class name.
- Exceptions:
-
void CIMClass::getKeyNames |
( |
Array< CIMName > & |
keyNames |
) |
const |
Gets the list of key properties in this class. The Key qualifier on CIMProperty objects is used to locate key properties.
- Returns:
- An Array of CIMName objects containing the names of the key properties.
- Exceptions:
-
Gets the method at the specified index.
- Parameters:
-
| index | The index of the method to be retrieved. |
- Returns:
- The CIMConstMethod at the specified index.
- Exceptions:
-
CIMMethod CIMClass::getMethod |
( |
Uint32 |
index |
) |
|
Gets the method at the specified index.
- Parameters:
-
| index | The index of the method to be retrieved. |
- Returns:
- The CIMMethod at the specified index.
- Exceptions:
-
Uint32 CIMClass::getMethodCount |
( |
|
) |
const |
Gets the number of methods in the class.
- Returns:
- An integer count of the methods in the CIMClass.
- Exceptions:
-
Gets the object path for the class.
- Returns:
- A CIMObjectPath containing the object path.
- Exceptions:
-
Gets the property at the specified index.
- Parameters:
-
| index | The index of the property to be retrieved. |
- Returns:
- The CIMConstProperty at the specified index.
- Exceptions:
-
Gets the property at the specified index.
- Parameters:
-
| index | The index of the property to be retrieved. |
- Returns:
- The CIMProperty at the specified index.
- Exceptions:
-
Uint32 CIMClass::getPropertyCount |
( |
|
) |
const |
Gets the number of properties in the class.
- Returns:
- An integer count of the properties in the CIMClass.
- Exceptions:
-
Gets the qualifier at the specified index.
- Parameters:
-
| index | The index of the qualifier to be retrieved. |
- Returns:
- The CIMConstQualifier at the specified index.
- Exceptions:
-
Gets the qualifier at the specified index.
- Parameters:
-
| index | The index of the qualifier to be retrieved. |
- Returns:
- The CIMQualifier at the specified index.
- Exceptions:
-
Uint32 CIMClass::getQualifierCount |
( |
|
) |
const |
Gets the number of qualifiers in the class.
- Returns:
- An integer count of the qualifiers in the CIMClass.
- Exceptions:
-
const CIMName& CIMClass::getSuperClassName |
( |
|
) |
const |
Gets the name of the parent class of this class.
- Returns:
- A CIMName containing parent class name.
- Exceptions:
-
Boolean CIMClass::hasKeys |
( |
|
) |
const |
Indicates whether this class contains key properties. The Key qualifier on CIMProperty objects is used to make this determination.
- Returns:
- True if this class contains key properties, false otherwise.
- Exceptions:
-
Compares the CIMClass with a specified CIMConstClass.
- Parameters:
-
- Returns:
- True if this class is identical to the one specified, false otherwise.
- Exceptions:
-
Boolean CIMClass::isAbstract |
( |
|
) |
const |
Indicates whether this class is an abstract class. The Abstract qualifier is used to make this determination.
- Returns:
- True if this class is an abstract class, false otherwise.
- Exceptions:
-
Boolean CIMClass::isAssociation |
( |
|
) |
const |
Indicates whether this class is an association class. An association is a relationship between two (or more) classes or instances. The Association qualifier is used to make this determination.
- Returns:
- True if this class is an association class, false otherwise.
- Exceptions:
-
Boolean CIMClass::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 CIMClass object to this object, so that both objects refer to the same data copy.
- Parameters:
-
- Returns:
- A reference to this CIMClass object.
void CIMClass::removeMethod |
( |
Uint32 |
index |
) |
|
Removes a method from the class.
- Parameters:
-
| index | The index of the method to remove. |
- Exceptions:
-
void CIMClass::removeProperty |
( |
Uint32 |
index |
) |
|
Removes a property from the class.
- Parameters:
-
| index | The index of the property to remove. |
- Exceptions:
-
void CIMClass::removeQualifier |
( |
Uint32 |
index |
) |
|
Removes a qualifier from the class.
- Parameters:
-
| index | The index of the qualifier to remove. |
- Exceptions:
-
Sets the object path for the class.
- Parameters:
-
- Exceptions:
-
void CIMClass::setSuperClassName |
( |
const CIMName & |
superClassName |
) |
|
Sets the name of the parent class.
- Parameters:
-
| superClassName | A CIMName specifying the parent class name. |
- Exceptions:
-
The documentation for this class was generated from the following file:
- /usr/src/startcom/BUILD/pegasus/src/Pegasus/Common/CIMClass.h