version 1.8, 2001/04/08 01:13:21
|
version 1.65, 2004/06/30 21:07:54
|
|
|
//BEGIN_LICENSE |
//%2003//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000 The Open Group, BMC Software, Tivoli Systems, IBM |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Development |
|
// Company, L. P., IBM Corp., The Open Group, Tivoli Systems. |
|
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.; |
|
// IBM Corp.; EMC Corporation, The Open Group. |
|
// |
|
// Permission is hereby granted, free of charge, to any person obtaining a copy |
|
// of this software and associated documentation files (the "Software"), to |
|
// deal in the Software without restriction, including without limitation the |
|
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
|
// sell copies of the Software, and to permit persons to whom the Software is |
|
// furnished to do so, subject to the following conditions: |
|
// |
|
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN |
|
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED |
|
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
|
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
|
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
|
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
|
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
// |
|
//============================================================================== |
|
// |
|
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) |
|
// Carol Ann Krug Graves, Hewlett-Packard Company |
|
// (carolann_graves@hp.com) |
|
// Adriann Schuur (schuur@de.ibm.com) PEP 164 |
|
// Karl Schopmeyer k.schopmeyer@opengroup.org (PEP 157) |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a |
//%///////////////////////////////////////////////////////////////////////////// |
// copy of this software and associated documentation files (the "Software"), |
|
// to deal in the Software without restriction, including without limitation |
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
// and/or sell copies of the Software, and to permit persons to whom the |
|
// Software is furnished to do so, subject to the following conditions: |
|
// |
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
|
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|
// DEALINGS IN THE SOFTWARE. |
|
// |
|
//END_LICENSE |
|
//BEGIN_HISTORY |
|
// |
|
// Author: |
|
// |
|
// $Log$ |
|
// Revision 1.8 2001/04/08 01:13:21 mike |
|
// Changed "ConstCIM" to "CIMConst" |
|
// |
|
// Revision 1.6 2001/03/29 16:40:31 karl |
|
// add doc |
|
// |
|
// Revision 1.5 2001/03/04 21:57:34 bob |
|
// Changed print methods to take a stream instead of hardcoded cout |
|
// |
|
// Revision 1.4 2001/02/26 10:13:24 karl |
|
// documentation changes |
|
// |
|
// Revision 1.3 2001/02/20 05:16:57 mike |
|
// Implemented CIMInstance::getInstanceName() |
|
// |
|
// Revision 1.2 2001/02/19 01:47:16 mike |
|
// Renamed names of the form CIMConst to CIMConst. |
|
// |
|
// Revision 1.1 2001/02/18 18:39:05 mike |
|
// new |
|
// |
|
// Revision 1.2 2001/02/18 03:56:00 mike |
|
// Changed more class names (e.g., ConstClassDecl -> CIMConstClass) |
|
// |
|
// Revision 1.1 2001/02/16 02:06:06 mike |
|
// Renamed many classes and headers. |
|
// |
|
// Revision 1.5 2001/01/30 23:39:00 karl |
|
// Add doc++ Documentation to header files |
|
// |
|
// Revision 1.4 2001/01/28 18:48:07 mike |
|
// fixed typo in comment |
|
// |
|
// Revision 1.3 2001/01/28 18:46:50 mike |
|
// more docs |
|
// |
|
// Revision 1.2 2001/01/15 04:31:43 mike |
|
// worked on resolve scheme |
|
// |
|
// Revision 1.1.1.1 2001/01/14 19:50:37 mike |
|
// Pegasus import |
|
// |
|
// |
|
//END_HISTORY |
|
| |
#ifndef Pegasus_ClassDecl_h |
#ifndef Pegasus_CIMClass_h |
#define Pegasus_ClassDecl_h |
#define Pegasus_CIMClass_h |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
#include <Pegasus/Common/CIMClassRep.h> |
#include <Pegasus/Common/Linkage.h> |
|
#include <Pegasus/Common/CIMName.h> |
|
#include <Pegasus/Common/CIMObject.h> |
|
#include <Pegasus/Common/CIMMethod.h> |
|
#include <Pegasus/common/CIMInstance.h> |
|
#include <Pegasus/Common/CIMPropertyList.h> |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class CIMConstClass; | class CIMConstClass; |
|
class CIMClassRep; |
|
class Resolver; |
| |
/** The CIMClass class is used to represent CIM classes in Pegasus. In CIM, |
|
a class object may be a class or an associator. A CIM class must contain a |
|
name and may contain methods, properties, and qualifiers. It is a template |
|
for creating a CIM instance. A CIM class represents a collection of CIM |
|
instances, all of which support a common type (for example, a set of |
|
properties, methods, and associations). |
|
*/ |
|
| |
|
/** The CIMClass class is used to represent CIM classes in Pegasus. |
|
*/ |
class PEGASUS_COMMON_LINKAGE CIMClass | class PEGASUS_COMMON_LINKAGE CIMClass |
{ | { |
public: | public: |
| |
/** Constructor - Creates an uninitiated a new CIM object |
/** Creates an uninitialized new CIM object representing a CIM class. |
reprenting a CIM class. The class object created by this |
The class object created by this constructor can only be used |
constructor can only be used in an operation such as the |
in an operation such as the copy constructor. It cannot be used |
copy constructor. It cannot be used to create a class by |
to create a class by appending names, properties, etc. since it |
appending names, properties, etc. since it is unitiated. |
is uninitialized. |
|
|
Use one of the other constructors to create an initiated new CIM class |
Use one of the other constructors to create an initialized new |
object. |
CIM class object. |
@exception Throws an exception "unitialized handle" if this |
@exception UninitializedObjectException if an attempt is made to |
unitialized handle is used |
use the unitialized object. |
/REF(HPEGASUS_HANDLES) |
*/ |
|
CIMClass(); |
|
|
|
/** Creates a new CIM object representing a CIMClass from the given |
|
CIMClass object. |
|
@param x CIMClass Object from which to create the CIMClass |
|
*/ |
|
CIMClass(const CIMClass& x); |
|
|
|
/** Creates a new CIMClass object representing a CIMClass from the given |
|
CIMObject Object. |
|
@param x CIMObject object from which to create the CIMClass object. |
|
@exception DynamicCastFailedException If a CIMClass can not be |
|
created from the given CIMObject. |
|
*/ |
|
PEGASUS_EXPLICIT CIMClass(const CIMObject& x); |
|
|
|
/** Creates a new CIM object representing a CIMClass from inputs |
|
of a classname and SuperClassName. |
|
@param className CIMName representing name of the class being created. |
|
@param superClassName CIMName representing name of the SuperClass. |
|
<pre> |
|
CIMClass NewClass("MyClass", "YourClass"); |
|
</pre> |
*/ | */ |
CIMClass() : _rep(0) |
CIMClass( |
{ |
const CIMName& className, |
|
const CIMName& superClassName = CIMName()); |
|
|
|
/// |
|
CIMClass& operator=(const CIMClass& x); |
| |
} |
/// Destructor |
|
~CIMClass(); |
| |
/** Constructor - Creates a class from a previous class |
/** Identifies whether or not this CIM class is an association. An |
|
association is a relationship between two (or more) classes or |
|
instances of two classes. The properties of an association class |
|
include pointers, or references, to the two (or more) instances. |
|
All CIM classes can be included in one or more associations. |
|
@return true if this CIM class is an association, false |
|
otherwise. |
*/ | */ |
CIMClass(const CIMClass& x) |
Boolean isAssociation() const; |
{ |
|
Inc(_rep = x._rep); |
/** Tests if the CIMClass is abstract. |
} |
@return true if the CIMClass Object is abstract, false otherwise. |
|
*/ |
|
Boolean isAbstract() const; |
| |
/// Operator = Assigns the CIM Class constructor. |
|
CIMClass& operator=(const CIMClass& x) |
|
{ |
|
if (x._rep != _rep) |
|
{ |
|
Dec(_rep); |
|
Inc(_rep = x._rep); |
|
} |
|
return *this; |
|
} |
|
|
|
/** Constructor - Creates a Class from inputs of a classname and |
|
SuperClassName |
|
@param className - String representing name of the class being created |
|
@param superClassName - String representing name of the SuperClass |
|
ATTN: Define what makes up legal name. |
|
@return Throws IllegalName if className argument illegal CIM identifier. |
|
<pre> |
|
CIMClass NewCass("MyClass", "YourClass"); |
|
</pre> |
|
| |
|
/** Gets the name of the class represented by this CIM object. |
|
@return CIMName with the class name. |
*/ | */ |
CIMClass( |
const CIMName& getClassName() const; |
const String& className, |
|
const String& superClassName = String()) |
|
{ |
|
_rep = new CIMClassRep(className, superClassName); |
|
} |
|
| |
/// Destructor |
/// |
~CIMClass() |
const CIMObjectPath& getPath() const; |
{ |
|
Dec(_rep); |
|
} |
|
| |
/** CIMMethod isAssociation - Identifies whether or not this CIM class |
/** Sets the object path for the class. |
is an association. An association is a relationship between two |
@param path CIMObjectPath containing the object path. |
(or more) classes or instances of two classes. The properties of an |
|
association class include pointers, or references, to the two (or |
|
more) instances. All CIM classes can be included in one or more |
|
associations. ATTN: Move the association definition elsewhere |
|
@return Boolean True if this CIM class belongs to an association; |
|
otherwise, false. |
|
*/ | */ |
Boolean isAssociation() const |
void setPath (const CIMObjectPath & path); |
{ |
|
_checkRep(); |
|
return _rep->isAssociation(); |
|
} |
|
| |
/// CIMMethod isAbstract |
/** Gets the name of the Parent class of this CIM Object. |
Boolean isAbstract() const |
@return CIMName with parent class name. |
{ |
*/ |
_checkRep(); |
const CIMName& getSuperClassName() const; |
return _rep->isAbstract(); |
|
} |
|
| |
/** CIMMethod Gets the name of the class |
/** Sets the name of the parent class from the input |
ATTN: COMMENT. Why not just get name so we have common method for all. |
parameter. |
|
@param superClassName - CIMName defining parent class name. |
*/ | */ |
const String& getClassName() const |
void setSuperClassName(const CIMName& superClassName); |
{ |
|
_checkRep(); |
|
return _rep->getClassName(); |
|
} |
|
| |
/** CIMMethod getSuperClassName - Gets the name of the Parent |
/** Adds the specified qualifier to the class and increments the |
@return String with parent class name. |
qualifier count. It is illegal to add the same qualifier more |
|
than one time. |
|
@param qualifier CIMQualifier object representing the qualifier |
|
to be added. |
|
@return the CIMClass object. |
|
@exception AlreadyExistsException if the qualifier already exists. |
*/ | */ |
const String& getSuperClassName() const |
CIMClass& addQualifier(const CIMQualifier& qualifier); |
{ |
|
_checkRep(); |
/** Searches for a qualifier with the specified input name if it |
return _rep->getSuperClassName(); |
exists in the class. |
} |
@param name CIMName of the qualifier to be found |
|
@return Index of the qualifier found or PEG_NOT_FOUND |
/** CIMMethod setSuperClassName - Sets the name of the parent class from |
if not found. |
the input parameter. \REF{CLASSNAME}. ATTN: Define legal classnames |
|
@param - String defining parent name. |
|
@return Throws IllegalName if superClassName argument not legal CIM |
|
identifier. |
|
*/ | */ |
void setSuperClassName(const String& superClassName) |
Uint32 findQualifier(const CIMName& name) const; |
{ |
|
_checkRep(); |
/** Gets the CIMQualifier object defined by the input parameter. |
_rep->setSuperClassName(superClassName); |
@param index Index of the qualifier in the class from the |
} |
findQualifier method. |
|
@return CIMQualifier object representing the qualifier found. |
/** CIMMethod addQualifier - Adds the specified qualifier to the class |
On error, CIMQualifier object will be null. |
and increments the qualifier count. It is illegal to add the same |
@exception IndexOutOfBoundsException exception if the index is |
qualifier more than one time. |
outside the range of parameters available from the CIMClass. |
@param - CIMQualifier object representing the qualifier to be added |
|
ATTN: Pointer to qualifier object. |
|
@return Throws AlreadyExists. |
|
*/ | */ |
CIMClass& addQualifier(const CIMQualifier& qualifier) |
CIMQualifier getQualifier(Uint32 index); |
{ |
|
_checkRep(); |
/** Gets the qualifier defined by the input parameter from the |
_rep->addQualifier(qualifier); |
qualifier list for this CIMClass. |
return *this; |
@param index Index of the qualifier in the CIM class. |
} |
@return CIMConstQualifier object representing the qualifier |
|
found. On error, CIMConstQualifier object will be null. |
/** CIMMethod findQualifier - Finds a qualifier with the specified input |
@exception IndexOutOfBoundsException exception if the index is |
name if it exists in the class @param name CIMName of the qualifier |
outside the range of parameters available from the CIMClass. |
to be found @return Position of the qualifier in the Class ATTN: |
|
Clarify the return. What if not found, etc. |
|
*/ | */ |
Uint32 findQualifier(const String& name) |
CIMConstQualifier getQualifier(Uint32 index) const; |
{ |
|
_checkRep(); |
/** Removes the qualifier defined by the index parameter. |
return _rep->findQualifier(name); |
@param index Defines the index of the qualifier to be removed. |
} |
@exception IndexOutOfBoundsException if the index is outside |
|
the range of existing qualifier objects for this class. |
/** CIMMethod FindQualifier - ATTN: |
|
@param name of the qualifier to be found |
|
@return ATTN: Define this |
|
*/ | */ |
Uint32 findQualifier(const String& name) const |
void removeQualifier(Uint32 index); |
{ |
|
_checkRep(); |
/** Gets the count of the number of qualifiers defined in the class. |
return _rep->findQualifier(name); |
@return the number of qualifiers in the class definition (not |
} |
those on properties or methods) |
|
|
/** CIMMethod getQualifier - Gets the CIMQualifier object defined |
|
by the input parameter |
|
@param pos defines the position of the qualifier in the class from the |
|
findQualifier method |
|
@return CIMQualifier object representing the qualifier found. |
|
ATTN: what is error return here? |
|
*/ | */ |
CIMQualifier getQualifier(Uint32 pos) |
Uint32 getQualifierCount() const; |
{ |
|
_checkRep(); |
|
return _rep->getQualifier(pos); |
|
} |
|
| |
/// CIMMethod getQualifier - ATTN: |
/** Adds the specified property object to the properties in |
CIMConstQualifier getQualifier(Uint32 pos) const |
the CIM class |
{ |
@param x CIMProperty to be added to the CIM Class. |
_checkRep(); |
@return CIMClass object after the specified property is added. |
return _rep->getQualifier(pos); |
|
} |
|
|
|
/** CIMMethod getQualifierCount - Returns the number of qualifiers |
|
in the class. |
|
@return ATTN: |
|
*/ | */ |
Uint32 getQualifierCount() const |
CIMClass& addProperty(const CIMProperty& x); |
{ |
|
_checkRep(); |
|
return _rep->getQualifierCount(); |
|
} |
|
| |
/** CIMMethod addProperty - Adds the specified property object to the |
/** Finds the property object with the name defined by the |
properties in the CIM class |
input parameter in the class. |
|
@param name CIMName with the property name to be found. |
|
@return Index of the property object found or |
|
PEG_NOT_FOUND if the property is not found. |
*/ | */ |
CIMClass& addProperty(const CIMProperty& x) |
Uint32 findProperty(const CIMName& name) const; |
{ |
|
_checkRep(); |
/** Gets a property object from the CIMClass. |
_rep->addProperty(x); |
@param index Index for the property object to get. |
return *this; |
@return CIMProperty object requested. |
} |
@exception IndexOutOfBoundsException if the index is outside |
|
the range of properties in this class. |
/** CIMMethod removeProperty - Removes the property represented |
|
by the position input parameter from the class |
|
@param position parameter for the property to be removed from the |
|
findPropety method |
|
@return ATTN: |
|
*/ | */ |
void removeProperty(Uint32 pos) |
CIMProperty getProperty(Uint32 index); |
{ |
|
_checkRep(); |
/** Gets a property object from the CIMClass. |
_rep->removeProperty(pos); |
@param index Index for the property object to get. |
} |
@return CIMProperty object requested. |
|
@exception IndexOutOfBoundsException if the index is outside |
/** CIMMethod findProperty - Finds the property object with the |
the range of properties in this class. |
name defined by the input parameter in the class. |
|
@param String parameter with the property name. |
|
@return position representing the property object found. |
|
ATTN: Clarify case of not found |
|
*/ | */ |
Uint32 findProperty(const String& name) |
CIMConstProperty getProperty(Uint32 index) const; |
{ |
|
_checkRep(); |
|
return _rep->findProperty(name); |
|
} |
|
| |
/// CIMMethod findProperty |
/** Removes the specified property from the class. |
Uint32 findProperty(const String& name) const |
@param index Index of the property to be removed. |
{ |
@exception IndexOutOfBoundsException if the index is outside |
_checkRep(); |
the range of properties in this class. |
return _rep->findProperty(name); |
|
} |
|
|
|
/** CIMMethod getProperty - Returns a property representing the property |
|
defined by the input parameter |
|
@param position for this property |
|
ATTN: Should we not use something like handle for position??? |
|
@return CIMProperty object |
|
ATTN: what is error return? |
|
*/ | */ |
CIMProperty getProperty(Uint32 pos) |
void removeProperty(Uint32 index); |
{ |
|
_checkRep(); |
|
return _rep->getProperty(pos); |
|
} |
|
| |
/// CIMMethod getProperty - ATTN |
/** Gets the count of the number of properties defined in the class. |
CIMConstProperty getProperty(Uint32 pos) const |
@return count of number of properties in the class. |
{ |
|
_checkRep(); |
|
return _rep->getProperty(pos); |
|
} |
|
|
|
/** CIMMethod getProperty - Gets the count of the number of properties |
|
defined in the class. |
|
@return count of number of proerties in the class |
|
*/ | */ |
Uint32 getPropertyCount() const |
Uint32 getPropertyCount() const; |
{ |
|
_checkRep(); |
/** Adds the method object defined by the input parameter to the |
return _rep->getPropertyCount(); |
class and increments the count of the number of methods in the class. |
} |
@param name CIMMethod object representing the method to be added. |
|
@return the CIMClass object to which the method was added. |
/** CIMMethod addMethod - Adds the method object defined by the input |
@exception AlreadyExistsException if the method already exists. |
parameter to the class and increments the count of the number of |
@exception UninitializedObjectException if the object is not initialized. |
methods in the class |
|
@param - method object representing the method to be added |
|
*/ | */ |
CIMClass& addMethod(const CIMMethod& x) |
CIMClass& addMethod(const CIMMethod& x); |
{ |
|
_checkRep(); |
/** Locate the method object defined by the input parameter. |
_rep->addMethod(x); |
@param name CIMName representing the name of the method to be found. |
return *this; |
@return Position of the method object in the class. |
} |
|
|
|
/** CIMMethod findMethod - Located the method object defined by the |
|
name input |
|
@param String representing the name of the method to be found |
|
@return Position of the method object in the class to be used in |
|
subsequent getmethod, etc. operations |
|
*/ | */ |
Uint32 findMethod(const String& name) |
Uint32 findMethod(const CIMName& name) const; |
{ |
|
_checkRep(); |
|
return _rep->findMethod(name); |
|
} |
|
| |
/// CIMMethod findMethod - ATTN: |
/** Gets the method object defined by the input parameter. |
Uint32 findMethod(const String& name) const |
@param index Index to the method object to get. |
{ |
@return CIMMethod object of the method requested. |
_checkRep(); |
@exception IndexOutOfBoundsException if the index is outside |
return _rep->findMethod(name); |
the range of methods in this class. |
} |
|
|
|
/** CIMMethod getMethod - Gets the method object defined by the |
|
input parameter. |
|
@param ATTN: |
|
@ method object representing the method defined |
|
ATTN: Error??? |
|
*/ | */ |
CIMMethod getMethod(Uint32 pos) |
CIMMethod getMethod(Uint32 index); |
{ |
|
_checkRep(); |
|
return _rep->getMethod(pos); |
|
} |
|
| |
/// CIMMethod getMethod - ATTN: |
/** Gets the method object defined by the input parameter. |
CIMConstMethod getMethod(Uint32 pos) const |
@param index Index to the method object to get. |
{ |
@return CIMConstMethod object of the method requested. |
_checkRep(); |
@exception IndexOutOfBoundsException if the index is outside |
return _rep->getMethod(pos); |
the range of methods in this class. |
} |
*/ |
|
CIMConstMethod getMethod(Uint32 index) const; |
| |
/** CIMMethod getMethodCount - Count of the number of methods in the class |
/** Removes the method defined by the index parameter. |
@return integer representing the number of methods in the class |
@param index Defines the index of the method to be removed. |
|
@exception IndexOutOfBoundsException if the index is outside |
|
the range of methods in this class. |
*/ | */ |
Uint32 getMethodCount() const |
void removeMethod(Uint32 index); |
{ |
|
_checkRep(); |
|
return _rep->getMethodCount(); |
|
} |
|
|
|
/** CIMMethod Resolve - Resolve the class: inherit any properties and |
|
qualifiers. Make sure the superClass really exists and is consistent |
|
with this class. Also set the propagated flag class-origin for each |
|
class feature. |
|
ATTN: explain why this here |
|
*/ |
|
void resolve( |
|
DeclContext* declContext, |
|
const String& nameSpace) |
|
{ |
|
_checkRep(); |
|
_rep->resolve(declContext, nameSpace); |
|
} |
|
| |
/// operator - ATTN: |
/** Gets the count of the number of methods in the class. |
operator int() const { return _rep != 0; } |
@return the count of the number of methods in the class object. |
|
*/ |
|
Uint32 getMethodCount() const; |
| |
/// CIMMethod toXML |
/// Get names of all keys of this class. |
void toXml(Array<Sint8>& out) const |
void getKeyNames(Array<CIMName>& keyNames) const; |
{ |
|
_checkRep(); |
|
_rep->toXml(out); |
|
} |
|
| |
/// CIMMethod print |
/** Determines if the object has keys. |
void print(std::ostream &o=std::cout) const |
@return true if the object has keys, false otherwise. |
{ |
|
_checkRep(); |
|
_rep->print(o); |
|
} |
|
|
|
/** CIMMethod identical - Compares with another class |
|
ATTN: Clarify exactly what identical means |
|
@parm Class object for the class to be compared |
|
@return True if the classes are identical |
|
*/ | */ |
Boolean identical(const CIMConstClass& x) const; |
Boolean hasKeys() const; |
| |
/// CIMMethod clone - ATTN: |
/** Makes a deep copy (clone) of the given object. |
CIMClass clone() const |
@return copy of the CIMClass object. |
{ |
*/ |
return CIMClass(_rep->clone()); |
CIMClass clone() const; |
} |
|
| |
void getKeyNames(Array<String>& keyNames) const |
/** Compares with another CIM class. |
{ |
@param x Class object for the class to be compared. |
_checkRep(); |
@return true if the classes are identical, false otherwise. |
_rep->getKeyNames(keyNames); |
*/ |
} |
Boolean identical(const CIMConstClass& x) const; |
|
|
|
/** Determines if the object has not been initialized. |
|
@return true if the object has not been initialized, |
|
false otherwise. |
|
*/ |
|
Boolean isUninitialized() const; |
|
|
|
/** |
|
Build a CIMInstance based on this CIM Class. Properties in the instance |
|
are initialized to the default values (if any) specified in the class |
|
definition. The parameters of the call determine whether qualifiers are |
|
included, the class origin attributes are included and which properties |
|
are included in the new instance. This method is designed specifically |
|
for providers to allow them to easily build instance objects using the |
|
parameters provided with the CIM instance operations such as getInstance, |
|
enumerateInstances. |
|
|
|
@param includeQualifiers If true attaches the class level qualifiers from |
|
this class to the instance and all properties inserted in the instance. |
|
If false, no qualifiers are attached to the instance or to any properties |
|
included in the instance. The TOINSTANCE flavor is ignored. Because |
|
there is still confusion over the exact operation of this parameter in the |
|
CIM specifications and the concept of instance level qualifiers, the |
|
behavior of this function when the parameter is true MAY change in the |
|
future to match any future clarifications of interoperable behavior in the |
|
CIM specifications. |
|
|
|
@param includeClassOrigin If true ClassOrigin attributes attached to |
|
properties inthe class object are transferred to the properties attached |
|
to the instance object. If false, any ClassOrigin attributes are ignored. |
|
|
|
@param propertyList A CIMPropertyList defining the properties that are to |
|
be added to the created instance. If propertyList is not NULL properties |
|
defined in the class and in this propertyList are added to the new |
|
instance. If the propertyLlist is NULL, all properties are added to the |
|
instance. If the propertyList exists but is empty, not properties are |
|
added. Note that this function does NOT generate an error if a property |
|
name is supplied that is NOT in the class; it simply does not add that |
|
property to the instance. |
|
|
|
@return CIMInstance of this class appropriately initialized. |
|
|
|
EXAMPLE: |
|
|
|
<Will be provided with the code> |
|
*/ |
|
CIMInstance createInstance(Boolean includeQualifiers, |
|
Boolean includeClassOrigin, |
|
const CIMPropertyList & propertyList) const; |
| |
private: | private: |
| |
CIMClass(CIMClassRep* rep) : _rep(rep) |
CIMClassRep* _rep; |
{ |
|
} |
|
| |
void _checkRep() const |
CIMClass(CIMClassRep* rep); |
{ |
|
if (!_rep) |
void _checkRep() const; |
throw UnitializedHandle(); |
|
} |
|
| |
CIMClassRep* _rep; |
|
friend class CIMConstClass; | friend class CIMConstClass; |
|
friend class CIMObject; |
|
friend class CIMConstObject; |
|
friend class Resolver; |
|
friend class XmlWriter; |
|
friend class MofWriter; |
|
friend class BinaryStreamer; |
}; | }; |
| |
/** CIMConstClass - ATTN: define this. |
#define PEGASUS_ARRAY_T CIMClass |
|
#include <Pegasus/Common/ArrayInter.h> |
*/ |
#undef PEGASUS_ARRAY_T |
| |
|
/// CIMConstClass |
class PEGASUS_COMMON_LINKAGE CIMConstClass | class PEGASUS_COMMON_LINKAGE CIMConstClass |
{ | { |
public: | public: |
| |
CIMConstClass() : _rep(0) |
/// |
{ |
CIMConstClass(); |
| |
} |
/// |
|
CIMConstClass(const CIMConstClass& x); |
| |
CIMConstClass(const CIMConstClass& x) |
/// |
{ |
CIMConstClass(const CIMClass& x); |
Inc(_rep = x._rep); |
|
} |
|
| |
CIMConstClass(const CIMClass& x) |
/// |
{ |
PEGASUS_EXPLICIT CIMConstClass(const CIMObject& x); |
Inc(_rep = x._rep); |
|
} |
|
| |
CIMConstClass& operator=(const CIMConstClass& x) |
/// |
{ |
PEGASUS_EXPLICIT CIMConstClass(const CIMConstObject& x); |
if (x._rep != _rep) |
|
{ |
|
Dec(_rep); |
|
Inc(_rep = x._rep); |
|
} |
|
return *this; |
|
} |
|
| |
CIMConstClass& operator=(const CIMClass& x) |
/// |
{ |
CIMConstClass( |
if (x._rep != _rep) |
const CIMName& className, |
{ |
const CIMName& superClassName = CIMName()); |
Dec(_rep); |
|
Inc(_rep = x._rep); |
|
} |
|
return *this; |
|
} |
|
| |
// Throws IllegalName if className argument not legal CIM identifier. |
/// |
|
CIMConstClass& operator=(const CIMConstClass& x); |
| |
CIMConstClass( |
/// |
const String& className, |
CIMConstClass& operator=(const CIMClass& x); |
const String& superClassName = String()) |
|
{ |
|
_rep = new CIMClassRep(className, superClassName); |
|
} |
|
| |
~CIMConstClass() |
/// |
{ |
~CIMConstClass(); |
Dec(_rep); |
|
} |
|
| |
Boolean isAssociation() const |
/// |
{ |
Boolean isAssociation() const; |
_checkRep(); |
|
return _rep->isAssociation(); |
|
} |
|
| |
Boolean isAbstract() const |
/// |
{ |
Boolean isAbstract() const; |
_checkRep(); |
|
return _rep->isAbstract(); |
|
} |
|
| |
const String& getClassName() const |
/// |
{ |
const CIMName& getClassName() const; |
_checkRep(); |
|
return _rep->getClassName(); |
|
} |
|
| |
const String& getSuperClassName() const |
/// |
{ |
const CIMObjectPath& getPath() const; |
_checkRep(); |
|
return _rep->getSuperClassName(); |
|
} |
|
| |
Uint32 findQualifier(const String& name) const |
/// |
{ |
const CIMName& getSuperClassName() const; |
_checkRep(); |
|
return _rep->findQualifier(name); |
|
} |
|
| |
CIMConstQualifier getQualifier(Uint32 pos) const |
/// |
{ |
Uint32 findQualifier(const CIMName& name) const; |
_checkRep(); |
|
return _rep->getQualifier(pos); |
|
} |
|
| |
Uint32 getQualifierCount() const |
/// |
{ |
CIMConstQualifier getQualifier(Uint32 index) const; |
_checkRep(); |
|
return _rep->getQualifierCount(); |
|
} |
|
| |
Uint32 findProperty(const String& name) const |
/// |
{ |
Uint32 getQualifierCount() const; |
_checkRep(); |
|
return _rep->findProperty(name); |
|
} |
|
| |
CIMConstProperty getProperty(Uint32 pos) const |
/// |
{ |
Uint32 findProperty(const CIMName& name) const; |
_checkRep(); |
|
return _rep->getProperty(pos); |
|
} |
|
| |
Uint32 getPropertyCount() const |
/// |
{ |
CIMConstProperty getProperty(Uint32 index) const; |
_checkRep(); |
|
return _rep->getPropertyCount(); |
|
} |
|
| |
Uint32 findMethod(const String& name) const |
/// |
{ |
Uint32 getPropertyCount() const; |
_checkRep(); |
|
return _rep->findMethod(name); |
|
} |
|
| |
CIMConstMethod getMethod(Uint32 pos) const |
/// |
{ |
Uint32 findMethod(const CIMName& name) const; |
_checkRep(); |
|
return _rep->getMethod(pos); |
|
} |
|
| |
Uint32 getMethodCount() const |
/// |
{ |
CIMConstMethod getMethod(Uint32 index) const; |
_checkRep(); |
|
return _rep->getMethodCount(); |
|
} |
|
| |
operator int() const { return _rep != 0; } |
/// |
|
Uint32 getMethodCount() const; |
| |
void toXml(Array<Sint8>& out) const |
/// |
{ |
void getKeyNames(Array<CIMName>& keyNames) const; |
_checkRep(); |
|
_rep->toXml(out); |
|
} |
|
| |
void print(std::ostream &o=std::cout) const |
/// |
{ |
Boolean hasKeys() const; |
_checkRep(); |
|
_rep->print(o); |
|
} |
|
| |
Boolean identical(const CIMConstClass& x) const |
/// |
{ |
CIMClass clone() const; |
x._checkRep(); |
|
_checkRep(); |
|
return _rep->identical(x._rep); |
|
} |
|
| |
CIMClass clone() const |
/// |
{ |
Boolean identical(const CIMConstClass& x) const; |
return CIMClass(_rep->clone()); |
|
} |
|
| |
void getKeyNames(Array<String>& keyNames) const |
/// |
{ |
Boolean isUninitialized() const; |
_checkRep(); |
|
_rep->getKeyNames(keyNames); |
|
} |
|
| |
private: | private: |
| |
void _checkRep() const |
|
{ |
|
if (!_rep) |
|
throw UnitializedHandle(); |
|
} |
|
|
|
CIMClassRep* _rep; | CIMClassRep* _rep; |
| |
|
void _checkRep() const; |
|
|
friend class CIMClassRep; | friend class CIMClassRep; |
friend class CIMClass; | friend class CIMClass; |
friend class CIMInstanceRep; | friend class CIMInstanceRep; |
|
friend class CIMObject; |
|
friend class CIMConstObject; |
|
friend class XmlWriter; |
|
friend class MofWriter; |
|
friend class BinaryStreamer; |
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
#endif /* Pegasus_ClassDecl_h */ |
#endif /* Pegasus_CIMClass_h */ |