pegasus/src/Pegasus/Common/CIMClass.h - diff

Return to CIMClass.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMClass.h between version 1.5 and 1.71.18.2

version 1.5, 2001/03/04 21:57:34

version 1.71.18.2, 2006/03/07 18:45:45

Line 1

//BEGIN_LICENSE

//%2006////////////////////////////////////////////////////////////////////////

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec 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.

// 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.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 ConstCIM.

// 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 -> ConstCIMClass)

// 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/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

class ConstCIMClass;

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 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.

class PEGASUS_COMMON_LINKAGE CIMClass

{

public:

/** Constructor - Creates and instantiates a new object reprenting a CIM

/**

class. If you use this constructor, use setName to define a name for

Constructs an uninitialized CIMClass object. A method

the class

invocation on an uninitialized object will result in the throwing

of an UninitializedObjectException. An uninitialized object may

CIMClass() : _rep(0)

be converted into an initialized object only by using the assignment

{

operator with an initialized object.

}

CIMClass();

/// Constructor - Creates a class from a previous class

/**

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.

Inc(_rep = x._rep);

@param x The CIMClass object from which to construct a new

}

CIMClass object.

/// Operator = ATTN:

CIMClass(const CIMClass& x);

CIMClass& operator=(const CIMClass& x)

{

/**

if (x._rep != _rep)

Constructs a CIMClass object from the value of a specified

{

CIMObject object, so that both objects refer to the same data copy.

Dec(_rep);

@param x The CIMObject object from which to construct the

Inc(_rep = x._rep);

CIMClass object.

}

@exception DynamicCastFailedException If a CIMClass can not be

return *this;

created from the given CIMObject.

}

PEGASUS_EXPLICIT CIMClass(const CIMObject& x);

/** Constructor - Creates a Class from inputs of a classname and

SuperClassName

/**

@param className - String representing name of the class being created

Constructs a CIMClass object with the specified attributes.

@param superClassName - String representing name of the SuperClass

Example:

ATTN: Define what makes up legal name.

<pre>

@return Throws IllegalName if className argument illegal CIM identifier.

CIMClass NewClass("MyClass", "YourClass");

</pre>

@param className A CIMName specifying the name of the class.

@param superClassName A CIMName specifying name of the parent class.

(A null value indicates no superclass.)

CIMClass(

const String& className,

const CIMName& className,

const String& superClassName = String())

const CIMName& superClassName = CIMName());

{

_rep = new CIMClassRep(className, superClassName);

}

/// Destructor

/**

~CIMClass()

Assigns the value of the specified CIMClass object to this object,

{

so that both objects refer to the same data copy.

Dec(_rep);

@param x The CIMClass object from which to assign this CIMClass

}

object.

@return A reference to this CIMClass object.

CIMClass& operator=(const CIMClass& x);

/**

Destructs the CIMClass object.

~CIMClass();

/**

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.

@return True if this class is an association class, false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean isAssociation() const;

/**

Indicates whether this class is an abstract class.

The Abstract qualifier is used to make this determination.

@return True if this class is an abstract class, false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean isAbstract() const;

/**

Gets the name of the class.

@return A CIMName containing the class name.

@exception UninitializedObjectException If the object is not

initialized.

const CIMName& getClassName() const;

/**

Gets the object path for the class.

@return A CIMObjectPath containing the object path.

@exception UninitializedObjectException If the object is not

initialized.

const CIMObjectPath& getPath() const;

/**

Sets the object path for the class.

@param path A CIMObjectPath containing the object path.

@exception UninitializedObjectException If the object is not

initialized.

void setPath (const CIMObjectPath & path);

/**

Gets the name of the parent class of this class.

@return A CIMName containing parent class name.

@exception UninitializedObjectException If the object is not

initialized.

const CIMName& getSuperClassName() const;

/**

Sets the name of the parent class.

@param superClassName A CIMName specifying the parent class name.

@exception UninitializedObjectException If the object is not

initialized.

void setSuperClassName(const CIMName& superClassName);

/**

Adds a qualifier to the class.

@param qualifier The CIMQualifier to be added.

@return A reference to this CIMClass object.

@exception AlreadyExistsException If a qualifier with the

same name already exists in the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMClass& addQualifier(const CIMQualifier& qualifier);

/**

Finds a qualifier by name.

@param name A CIMName specifying the name of the qualifier to be found.

@return Index of the qualifier if found or PEG_NOT_FOUND if not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findQualifier(const CIMName& name) const;

/**

Gets the qualifier at the specified index.

@param index The index of the qualifier to be retrieved.

@return The CIMQualifier at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of qualifiers available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMQualifier getQualifier(Uint32 index);

/**

Gets the qualifier at the specified index.

@param index The index of the qualifier to be retrieved.

@return The CIMConstQualifier at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of qualifiers available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstQualifier getQualifier(Uint32 index) const;

/**

Removes a qualifier from the class.

@param index The index of the qualifier to remove.

@exception IndexOutOfBoundsException If the index is

outside the range of qualifiers available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

void removeQualifier(Uint32 index);

/**

Gets the number of qualifiers in the class.

@return An integer count of the qualifiers in the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getQualifierCount() const;

/**

Adds a property to the class.

@param x The CIMProperty to be added.

@return A reference to this CIMClass object.

@exception AlreadyExistsException If a property with the

same name already exists in the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMClass& addProperty(const CIMProperty& x);

/**

Finds a property by name.

@param name A CIMName specifying the name of the property to be found.

@return Index of the property if found or PEG_NOT_FOUND if not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findProperty(const CIMName& name) const;

/**

Gets the property at the specified index.

@param index The index of the property to be retrieved.

@return The CIMProperty at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of properties available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMProperty getProperty(Uint32 index);

/**

Gets the property at the specified index.

@param index The index of the property to be retrieved.

@return The CIMConstProperty at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of properties available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstProperty getProperty(Uint32 index) const;

/**

Removes a property from the class.

@param index The index of the property to remove.

@exception IndexOutOfBoundsException If the index is

outside the range of properties available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

void removeProperty(Uint32 index);

/**

Gets the number of properties in the class.

@return An integer count of the properties in the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getPropertyCount() const;

/**

Adds a method to the class.

@param x The CIMMethod to be added.

@return A reference to this CIMClass object.

@exception AlreadyExistsException If a method with the

same name already exists in the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMClass& addMethod(const CIMMethod& x);

/**

Finds a method by name.

@param name A CIMName specifying the name of the method to be found.

@return Index of the method if found or PEG_NOT_FOUND if not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findMethod(const CIMName& name) const;

/**

Gets the method at the specified index.

@param index The index of the method to be retrieved.

@return The CIMMethod at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of methods available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMMethod getMethod(Uint32 index);

/**

Gets the method at the specified index.

@param index The index of the method to be retrieved.

@return The CIMConstMethod at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of methods available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstMethod getMethod(Uint32 index) const;

/**

Removes a method from the class.

@param index The index of the method to remove.

@exception IndexOutOfBoundsException If the index is

outside the range of methods available for the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

void removeMethod(Uint32 index);

/**

Gets the number of methods in the class.

@return An integer count of the methods in the CIMClass.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getMethodCount() const;

/**

Gets the list of key properties in this class. The Key qualifier

on CIMProperty objects is used to locate key properties.

@return An Array of CIMName objects containing the names of the key

properties.

@exception UninitializedObjectException If the object is not

initialized.

void getKeyNames(Array<CIMName>& keyNames) const;

/**

Indicates whether this class contains key properties. The Key

qualifier on CIMProperty objects is used to make this determination.

@return True if this class contains key properties, false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean hasKeys() const;

/**

Makes a deep copy of the class. This creates a new copy of all

the class attributes including qualifiers, properties, and methods.

@return A new copy of the CIMClass object.

@exception UninitializedObjectException If the object is not

initialized.

CIMClass clone() const;

/**

Compares the CIMClass with a specified CIMConstClass.

@param x The CIMConstClass to be compared.

@return True if this class is identical to the one specified,

false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean identical(const CIMConstClass& x) const;

/**

Determines whether the object has been initialized.

@return True if the object has not been initialized, false otherwise.

Boolean isUninitialized() const;

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

/**

Experimental Interface

Builds a CIMInstance based on this CIMClass. Properties in the

instance are initialized to the default values (if any) specified

in the class definition. The method arguments 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 and enumerateInstances.

Example:

<pre>

CIMClass myClass .. a defined and complete CIMClass.

// create instance with qualifiers, class origin and all properties

CIMInstance myInstance =

myClass.buildInstance(true, true, CIMPropertyList());

</pre>

@param includeQualifiers A Boolean indicating whether qualifiers in

the class definition (and its properties) are to be added to the

instance. If false, no qualifiers are added to the instance or its

properties. The TOINSTANCE flavor is ignored. Because the CIM

specification is unclear on the meaning of this parameter and its

relationship to instance operations, the behavior when this parameter

is true MAY change in the future based on clarifications of the

CIM specification.

@param includeClassOrigin A Boolean indicating whether ClassOrigin

attributes are to be transferred from the class object to the

instance.

@param propertyList A CIMPropertyList defining the properties that

are to be added to the created instance. If the propertyList is not

NULL, properties defined in the class and in this propertyList are

added to the new instance. If the propertyList is NULL, all

properties are added to the instance. If the propertyList is empty,

no 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.

@exception UninitializedObjectException If the object is not

initialized.

CIMInstance buildInstance(Boolean includeQualifiers,

Boolean includeClassOrigin,

const CIMPropertyList & propertyList) const;

#endif

/** CIMMethod isAssociation - Identifies whether or not this CIM class

private:

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. ATTN: Move the association definition elsewhere

@return Boolean True if this CIM class belongs to an association;

otherwise, false.

Boolean isAssociation() const

{

_checkRep();

return _rep->isAssociation();

}

/// CIMMethod isAbstract

Boolean isAbstract() const

{

_checkRep();

return _rep->isAbstract();

}

/** CIMMethod Gets the name of the class

ATTN: COMMENT. Why not just get name so we have common method for all.

const String& getClassName() const

{

_checkRep();

return _rep->getClassName();

}

/** CIMMethod getSuperClassName - Gets the name of the Parent

@return String with parent class name.

const String& getSuperClassName() const

{

_checkRep();

return _rep->getSuperClassName();

}

/** CIMMethod setSuperClassName - Sets the name of the parent class from

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)

{

_checkRep();

_rep->setSuperClassName(superClassName);

}

/** CIMMethod addQualifier - Adds the specified qualifier to the class

and increments the qualifier count. It is illegal to add the same

qualifier more than one time.

@param - CIMQualifier object representing the qualifier to be added

ATTN: Pointer to qualifier object.

@return Throws AlreadyExists.

CIMClass& addQualifier(const CIMQualifier& qualifier)

{

_checkRep();

_rep->addQualifier(qualifier);

return *this;

}

/** CIMMethod findQualifier - Finds a qualifier with the specified input

name if it exists in the class @param name CIMName of the qualifier

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)

{

_checkRep();

return _rep->findQualifier(name);

}

/** CIMMethod FindQualifier - ATTN:

@param name of the qualifier to be found

@return ATTN: Define this

Uint32 findQualifier(const String& name) const

{

_checkRep();

return _rep->findQualifier(name);

}

/** 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)

{

_checkRep();

return _rep->getQualifier(pos);

}

/// CIMMethod getQualifier - ATTN:

CIMClassRep* _rep;

CIMConstQualifier getQualifier(Uint32 pos) const

{

_checkRep();

return _rep->getQualifier(pos);

}

/** CIMMethod getQualifierCount - Returns the number of qualifiers

in the class.

@return ATTN:

Uint32 getQualifierCount() const

{

_checkRep();

return _rep->getQualifierCount();

}

/** CIMMethod addProperty - Adds the specified property object to the

CIMClass(CIMClassRep* rep);

properties in the CIM class

CIMClass& addProperty(const CIMProperty& x)

{

_checkRep();

_rep->addProperty(x);

return *this;

}

/** 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)

{

_checkRep();

_rep->removeProperty(pos);

}

/** CIMMethod findProperty - Finds the property object with the

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)

{

_checkRep();

return _rep->findProperty(name);

}

/// CIMMethod findProperty

void _checkRep() const;

Uint32 findProperty(const String& name) const

{

_checkRep();

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)

{

_checkRep();

return _rep->getProperty(pos);

}

/// CIMMethod getProperty - ATTN

friend class CIMConstClass;

ConstCIMProperty getProperty(Uint32 pos) const

friend class CIMObject;

{

friend class CIMConstObject;

_checkRep();

friend class Resolver;

return _rep->getProperty(pos);

friend class XmlWriter;

}

friend class MofWriter;

friend class BinaryStreamer;

/** 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

{

_checkRep();

return _rep->getPropertyCount();

}

/** CIMMethod addMethod - Adds the method object defined by the input

parameter to the class and increments the count of the number of

methods in the class

@param - method object representing the method to be added

CIMClass& addMethod(const CIMMethod& x)

{

_checkRep();

_rep->addMethod(x);

return *this;

}

/** 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)

{

_checkRep();

return _rep->findMethod(name);

}

/// CIMMethod findMethod - ATTN:

#define PEGASUS_ARRAY_T CIMClass

Uint32 findMethod(const String& name) const

#include <Pegasus/Common/ArrayInter.h>

{

#undef PEGASUS_ARRAY_T

_checkRep();

return _rep->findMethod(name);

}

/** 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)

{

_checkRep();

return _rep->getMethod(pos);

}

/// CIMMethod getMethod - ATTN:

CIMConstMethod getMethod(Uint32 pos) const

{

_checkRep();

return _rep->getMethod(pos);

}

/** CIMMethod getMethodCount - Count of the number of methods in the class

/**

@return integer representing the number of methods in the class

The CIMConstClass class provides a const interface to a CIMClass

object. This class is needed because the shared representation model

used by CIMClass does not prevent modification to a const CIMClass

object. Note that the value of a CIMConstClass object could still be

modified by a CIMClass object that refers to the same data copy.

Uint32 getMethodCount() const

class PEGASUS_COMMON_LINKAGE CIMConstClass

{

_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();

public:

_rep->resolve(declContext, nameSpace);

}

/// operator - ATTN:

operator int() const { return _rep != 0; }

/// CIMMethod toXML

void toXml(Array<Sint8>& out) const

{

_checkRep();

_rep->toXml(out);

}

/// CIMMethod print

/**

void print(std::ostream &o=std::cout) const

Constructs an uninitialized CIMConstClass object. A method

{

invocation on an uninitialized object will result in the throwing

_checkRep();

of an UninitializedObjectException. An uninitialized object may

_rep->print(o);

be converted into an initialized object only by using the assignment

}

operator with an initialized object.

/** CIMMethod identical - Compares with another class

CIMConstClass();

ATTN: Clarify exactly what identical means

@parm Class object for the class to be compared

/**

@return True if the classes are identical

Constructs a CIMConstClass object from the value of a specified

CIMConstClass object, so that both objects refer to the same data copy.

@param x The CIMConstClass object from which to construct a new

CIMConstClass object.

CIMConstClass(const CIMConstClass& x);

/**

Constructs a CIMConstClass object from the value of a specified

CIMClass object, so that both objects refer to the same data copy.

@param x The CIMClass object from which to construct a new

CIMConstClass object.

CIMConstClass(const CIMClass& x);

/**

Constructs a CIMConstClass object from the value of a specified

CIMObject object, so that both objects refer to the same data copy.

@param x The CIMObject object from which to construct the

CIMConstClass object.

@exception DynamicCastFailedException If a CIMConstClass can not be

created from the given CIMObject.

PEGASUS_EXPLICIT CIMConstClass(const CIMObject& x);

/**

Constructs a CIMConstClass object from the value of a specified

CIMConstObject object, so that both objects refer to the same data

copy.

@param x The CIMConstObject object from which to construct the

CIMConstClass object.

@exception DynamicCastFailedException If a CIMConstClass can not be

created from the given CIMConstObject.

PEGASUS_EXPLICIT CIMConstClass(const CIMConstObject& x);

/**

Constructs a CIMConstClass object with the specified attributes.

@param className A CIMName specifying the name of the class.

@param superClassName A CIMName specifying name of the parent class.

(A null value indicates no superclass.)

CIMConstClass(

const CIMName& className,

const CIMName& superClassName = CIMName());

/**

Assigns the value of the specified CIMConstClass object to this

object, so that both objects refer to the same data copy.

@param x The CIMConstClass object from which to assign this

CIMConstClass object.

@return A reference to this CIMConstClass object.

CIMConstClass& operator=(const CIMConstClass& x);

/**

Assigns the value of the specified CIMClass object to this

object, so that both objects refer to the same data copy.

@param x The CIMClass object from which to assign this

CIMConstClass object.

@return A reference to this CIMConstClass object.

CIMConstClass& operator=(const CIMClass& x);

/**

Destructs the CIMConstClass object.

~CIMConstClass();

/**

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.

@return True if this class is an association class, false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean isAssociation() const;

/**

Indicates whether this class is an abstract class.

The Abstract qualifier is used to make this determination.

@return True if this class is an abstract class, false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean isAbstract() const;

/**

Gets the name of the class.

@return A CIMName containing the class name.

@exception UninitializedObjectException If the object is not

initialized.

const CIMName& getClassName() const;

/**

Gets the object path for the class.

@return A CIMObjectPath containing the object path.

@exception UninitializedObjectException If the object is not

initialized.

const CIMObjectPath& getPath() const;

/**

Gets the name of the parent class of this class.

@return A CIMName containing parent class name.

@exception UninitializedObjectException If the object is not

initialized.

const CIMName& getSuperClassName() const;

/**

Finds a qualifier by name.

@param name A CIMName specifying the name of the qualifier to be found.

@return Index of the qualifier if found or PEG_NOT_FOUND if not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findQualifier(const CIMName& name) const;

/**

Gets the qualifier at the specified index.

@param index The index of the qualifier to be retrieved.

@return The CIMConstQualifier at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of qualifiers available for the CIMConstClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstQualifier getQualifier(Uint32 index) const;

/**

Gets the number of qualifiers in the class.

@return An integer count of the qualifiers in the CIMConstClass.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getQualifierCount() const;

/**

Finds a property by name.

@param name A CIMName specifying the name of the property to be found.

@return Index of the property if found or PEG_NOT_FOUND if not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findProperty(const CIMName& name) const;

/**

Gets the property at the specified index.

@param index The index of the property to be retrieved.

@return The CIMConstProperty at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of properties available for the CIMConstClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstProperty getProperty(Uint32 index) const;

/**

Gets the number of properties in the class.

@return An integer count of the properties in the CIMConstClass.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getPropertyCount() const;

/**

Finds a method by name.

@param name A CIMName specifying the name of the method to be found.

@return Index of the method if found or PEG_NOT_FOUND if not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findMethod(const CIMName& name) const;

/**

Gets the method at the specified index.

@param index The index of the method to be retrieved.

@return The CIMConstMethod at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of methods available for the CIMConstClass.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstMethod getMethod(Uint32 index) const;

/**

Gets the number of methods in the class.

@return An integer count of the methods in the CIMConstClass.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getMethodCount() const;

/**

Gets the list of key properties in this class. The Key qualifier

on CIMConstProperty objects is used to locate key properties.

@return An Array of CIMName objects containing the names of the key

properties.

@exception UninitializedObjectException If the object is not

initialized.

void getKeyNames(Array<CIMName>& keyNames) const;

/**

Indicates whether this class contains key properties. The Key

qualifier on CIMConstProperty objects is used to make this

determination.

@return True if this class contains key properties, false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean hasKeys() const;

/**

Makes a deep copy of the class. This creates a new copy of all

the class attributes including qualifiers, properties, and methods.

@return A CIMClass object with a separate copy of the

CIMConstClass object.

@exception UninitializedObjectException If the object is not

initialized.

CIMClass clone() const;

/**

Compares the CIMConstClass with a specified CIMConstClass.

@param x The CIMConstClass to be compared.

@return True if this class is identical to the one specified,

false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean identical(const CIMConstClass& x) const;

/**

Determines whether the object has been initialized.

@return True if the object has not been initialized, false otherwise.

Boolean identical(const ConstCIMClass& x) const;

Boolean isUninitialized() const;

/// CIMMethod clone - ATTN:

CIMClass clone() const

{

return CIMClass(_rep->clone());

}

void getKeyNames(Array<String>& keyNames) const

{

_checkRep();

_rep->getKeyNames(keyNames);

}

private:

CIMClass(CIMClassRep* rep) : _rep(rep)

{

}

void _checkRep() const

{

if (!_rep)

throw UnitializedHandle();

}

CIMClassRep* _rep;

friend class ConstCIMClass;

};

/** ConstCIMClass - ATTN: define this.

class PEGASUS_COMMON_LINKAGE ConstCIMClass

{

public:

ConstCIMClass() : _rep(0)

{

}

ConstCIMClass(const ConstCIMClass& x)

{

Inc(_rep = x._rep);

}

ConstCIMClass(const CIMClass& x)

{

Inc(_rep = x._rep);

}

ConstCIMClass& operator=(const ConstCIMClass& x)

{

if (x._rep != _rep)

{

Dec(_rep);

Inc(_rep = x._rep);

}

return *this;

}

ConstCIMClass& operator=(const CIMClass& x)

{

if (x._rep != _rep)

{

Dec(_rep);

Inc(_rep = x._rep);

}

return *this;

}

// Throws IllegalName if className argument not legal CIM identifier.

ConstCIMClass(

const String& className,

const String& superClassName = String())

{

_rep = new CIMClassRep(className, superClassName);

}

~ConstCIMClass()

{

Dec(_rep);

}

Boolean isAssociation() const

{

_checkRep();

return _rep->isAssociation();

}

Boolean isAbstract() const

{

_checkRep();

return _rep->isAbstract();

}

const String& getClassName() const

void _checkRep() const;

{

_checkRep();

return _rep->getClassName();

}

const String& getSuperClassName() const

{

_checkRep();

return _rep->getSuperClassName();

}

Uint32 findQualifier(const String& name) const

{

_checkRep();

return _rep->findQualifier(name);

}

CIMConstQualifier getQualifier(Uint32 pos) const

{

_checkRep();

return _rep->getQualifier(pos);

}

Uint32 getQualifierCount() const

{

_checkRep();

return _rep->getQualifierCount();

}

Uint32 findProperty(const String& name) const

{

_checkRep();

return _rep->findProperty(name);

}

ConstCIMProperty getProperty(Uint32 pos) const

{

_checkRep();

return _rep->getProperty(pos);

}

Uint32 getPropertyCount() const

{

_checkRep();

return _rep->getPropertyCount();

}

Uint32 findMethod(const String& name) const

{

_checkRep();

return _rep->findMethod(name);

}

CIMConstMethod getMethod(Uint32 pos) const

{

_checkRep();

return _rep->getMethod(pos);

}

Uint32 getMethodCount() const

{

_checkRep();

return _rep->getMethodCount();

}

operator int() const { return _rep != 0; }

void toXml(Array<Sint8>& out) const

{

_checkRep();

_rep->toXml(out);

}

void print(std::ostream &o=std::cout) const

{

_checkRep();

_rep->print(o);

}

Boolean identical(const ConstCIMClass& x) const

{

x._checkRep();

_checkRep();

return _rep->identical(x._rep);

}

CIMClass clone() const

{

return CIMClass(_rep->clone());

}

void getKeyNames(Array<String>& keyNames) const

{

_checkRep();

_rep->getKeyNames(keyNames);

}

private:

void _checkRep() const

{

if (!_rep)

throw UnitializedHandle();

}

CIMClassRep* _rep;

friend class CIMClassRep;

friend class CIMClass;

friend class CIMInstanceRep;

friend class CIMObject;

friend class CIMConstObject;

friend class XmlWriter;

friend class MofWriter;

friend class BinaryStreamer;

};

PEGASUS_NAMESPACE_END

#endif /* Pegasus_ClassDecl_h */

#endif /* Pegasus_CIMClass_h */

Legend:

Removed from v.1.5
changed lines
	Added in v.1.71.18.2

No CVS admin address has been configured