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.50 and 1.72

version 1.50, 2002/07/19 23:40:13

version 1.72, 2006/01/30 16:16:46

Line 1

//%/////////////////////////////////////////////////////////////////////////////

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

// The Open Group, Tivoli Systems

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

Line 21

Line 29

//==============================================================================

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

//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_CIMClass_h

#define Pegasus_CIMClass_h

#include <Pegasus/Common/Config.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 CIMConstClass;

class CIMClassRep;

class DeclContext;

class Resolver;

// REVIEW: redocument.

/** The CIMClass class is used to represent CIM classes in Pegasus. In CIM,

/** The CIMClass class is used to represent CIM classes in Pegasus.

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

class PEGASUS_COMMON_LINKAGE CIMClass

{

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 "unitialized handle" if this

@exception UninitializedObjectException if an attempt is made to

unitialized handle is used

use the unitialized object.

CIMClass();

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

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

PEGASUS_EXPLICIT CIMClass(const CIMObject& x)

/** Creates a new CIMClass object representing a CIMClass from the given

throw(DynamicCastFailed);

CIMObject Object.

@param x CIMObject object from which to create the CIMClass object.

// ATTN define what makes up a legal CIM class name

@exception DynamicCastFailedException If a CIMClass can not be

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

created from the given CIMObject.

SuperClassName

@param className CIMObjectPath representing name of the class being created

PEGASUS_EXPLICIT CIMClass(const CIMObject& x);

@param superClassName String representing name of the SuperClass

@return Throws IllegalName if className argument illegal CIM identifier.

/** 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 NewCass("MyClass", "YourClass");

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

</pre>

CIMClass(

const CIMObjectPath& reference,

const CIMName& className,

const String& superClassName = String::EMPTY);

const CIMName& superClassName = CIMName());

/** Assignment operator.

///

CIMClass& operator=(const CIMClass& x);

/// Destructor

~CIMClass();

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

/** Identifies whether or not this CIM class is an association. An

is an association. An association is a relationship between two

association is a relationship between two (or more) classes or

(or more) classes or instances of two classes. The properties of an

instances of two classes. The properties of an association class

association class include pointers, or references, to the two (or

include pointers, or references, to the two (or more) instances.

more) instances. All CIM classes can be included in one or more

All CIM classes can be included in one or more associations.

associations.

@return true if this CIM class is an association, false

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

otherwise.

otherwise, false.

Boolean isAssociation() const;

/** isAbstract Test if the CIMClass is abstract.

/** Tests if the CIMClass is abstract.

@return - True if the CIMClass Object is abstract

@return true if the CIMClass Object is abstract, false otherwise.

SeeAlso: Abstract

Boolean isAbstract() const;

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

/** getClassName Gets the name of the class

/** Gets the name of the class represented by this CIM object.

@return Returns string with the class name.

@return CIMName with the class name.

const String& getClassName() const;

const CIMName& getClassName() const;

///

const CIMObjectPath& getPath() const;

/**

/** Sets the object path for the class.

Sets the object path for the class

@param path CIMObjectPath containing the object path.

@param path CIMObjectPath containing the object path

void setPath (const CIMObjectPath & path);

/** getSuperClassName - Gets the name of the Parent

/** Gets the name of the Parent class of this CIM Object.

@return String with parent class name.

@return CIMName with parent class name.

const String& getSuperClassName() const;

const CIMName& getSuperClassName() const;

// ATTN define what's a legal class name

/** Sets the name of the parent class from the input

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

parameter.

the input parameter. \REF{CLASSNAME}.

@param superClassName - CIMName defining parent class name.

@param String defining parent name.

@return Throws IllegalName if superClassName argument not legal CIM

void setSuperClassName(const CIMName& superClassName);

identifier

@exception throws IllegalName if the name is not correct. See

/** Adds the specified qualifier to the class and increments the

\URL[ClassNames]{DefinitionofTerms.html#CLASSNAME}

qualifier count. It is illegal to add the same qualifier more

than one time.

void setSuperClassName(const String& superClassName);

@param qualifier CIMQualifier object representing the qualifier

to be added.

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

@return the CIMClass object.

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

@exception AlreadyExistsException if the qualifier already exists.

qualifier more than one time.

@param qualifier CIMQualifier object representing the qualifier to be

added

@return Returns handle of the class object

@exception Throws AlreadyExists.

CIMClass& addQualifier(const CIMQualifier& qualifier);

/** findQualifier - Searches for a qualifier with the specified `

/** Searches for a qualifier with the specified input name if it

input name if it exists in the class

exists in the class.

@param name CIMName of the qualifier

@param name CIMName of the qualifier to be found

to be found @return Position of the qualifier in the Class.

@return Index of the qualifier found or PEG_NOT_FOUND

@return Returns index of the qualifier found or PEG_NOT_FOUND

if not found.

Uint32 findQualifier(const String& name) const;

Uint32 findQualifier(const CIMName& name) const;

/** Gets the CIMQualifier object defined by the input parameter.

@param index Index of the qualifier in the class from the

findQualifier method.

@return CIMQualifier object representing the qualifier found.

On error, CIMQualifier object will be null.

@exception IndexOutOfBoundsException exception if the index is

outside the range of parameters available from the CIMClass.

CIMQualifier getQualifier(Uint32 index);

/** Gets the qualifier defined by the input parameter from the

qualifier list for this CIMClass.

@param index Index of the qualifier in the CIM class.

@return CIMConstQualifier object representing the qualifier

found. On error, CIMConstQualifier object will be null.

@exception IndexOutOfBoundsException exception if the index is

outside the range of parameters available from the CIMClass.

CIMConstQualifier getQualifier(Uint32 index) const;

/** Removes the qualifier defined by the index parameter.

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

void removeQualifier(Uint32 index);

/** isTrueQualifier - Determines if the qualifier defined by

/** Gets the count of the number of qualifiers defined in the class.

the input parameter exists for the class, is Boolean, and

@return the number of qualifiers in the class definition (not

has a value of true.

This function is useful to quickly determine the state of a

qualifier.

@param String containing the qualifier name.

@return Boolean True if the qualifier exists,

Boolean isTrueQualifier(const String& name) const;

/** 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. On error,

CIMQualifier handle will be null.

CIMQualifier getQualifier(Uint32 pos);

/** getQualifier - Gets the qualifier defined by the input parameter

from the qualifier list for this CIMClass.

CIMConstQualifier getQualifier(Uint32 pos) const;

/** removeQualifier - Removes the qualifier defined by the

index parameter.

@param Defines the index of the qualifier to be removed.

@return There is no return.

@exception Throw OutOfBound exception if the index is outside

the range of existing qualifier objects for this class

void removeQualifier(Uint32 pos);

/** getQualifierCount - Returns the number of qualifiers

in the class.

@return the number of qualifiers on the class definition (not

those on properties or methods)

Uint32 getQualifierCount() const;

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

/** Adds the specified property object to the properties in

properties in the CIM class

the CIM class

@param x CIMProperty to be added to the CIM Class.

@return CIMClass object after the specified property is added.

CIMClass& addProperty(const CIMProperty& x);

/** findProperty - Finds the property object with the

/** Finds the property object with the name defined by the

name defined by the input parameter in the class.

input parameter in the class.

@param String parameter with the property name.

@param name CIMName with the property name to be found.

@return position representing the property object found or

@return Index of the property object found or

PEG_NOT_FOUND if the property is not found.

Uint32 findProperty(const String& name) const;

Uint32 findProperty(const CIMName& name) const;

/** Gets a property object from the CIMClass.

@param index Index for the property object to get.

@return CIMProperty object requested.

@exception IndexOutOfBoundsException if the index is outside

the range of properties in this class.

CIMProperty getProperty(Uint32 index);

/** Gets a property object from the CIMClass.

@param index Index for the property object to get.

@return CIMProperty object requested.

@exception IndexOutOfBoundsException if the index is outside

the range of properties in this class.

CIMConstProperty getProperty(Uint32 index) const;

/** Removes the specified property from the class.

@param index Index of the property to be removed.

@exception IndexOutOfBoundsException if the index is outside

the range of properties in this class.

void removeProperty(Uint32 index);

// ATTN: Should we not use something like handle for position???

/** Gets the count of the number of properties defined in the class.

// ATTN: what is error return?

@return count of number of properties in the class.

/** getProperty - Returns a property representing the property

defined by the input parameter

@param position for this property

@return CIMProperty object

CIMProperty getProperty(Uint32 pos);

/**getProperty Gets a property object from the CIMClass

@param pos The index of the property object to get.

@return Returns handle of the property object requested

@exception Throws OutofBounds if the size field is greather than the

bunber of properties in the class.

CIMConstProperty getProperty(Uint32 pos) const;

/** removeProperty - Removes the property represented

by the position input parameter from the class

@param pos Index to the property to be removed from the

findPropety method

@exception Throws OutofBounds if index is not a property object

void removeProperty(Uint32 pos);

/** getPropertyCount - Gets the count of the number of properties

defined in the class.

@return count of number of proerties in the class

Uint32 getPropertyCount() const;

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

/** Adds the method object defined by the input parameter to the

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

class and increments the count of the number of methods in the class.

methods in the class

@param name CIMMethod object representing the method to be added.

@param method object representing the method to be added

@return the CIMClass object to which the method was added.

@return Returns the CIMClass object to which the method was added.

@exception AlreadyExistsException if the method already exists.

@exception Throws AlreadyExists if the method already exists and throws

@exception UninitializedObjectException if the object is not initialized.

UninitializedHandle if the handle is not initialized

CIMClass& addMethod(const CIMMethod& x);

/** findMethod - Locate the method object defined by the

/** Locate the method object defined by the input parameter.

name input

@param name CIMName representing the name of the method to be found.

@param String representing the name of the method to be found

@return Position of the method object in the class.

@return Position of the method object in the class to be used in

subsequent getmethod, etc. operations

Uint32 findMethod(const String& name) const;

Uint32 findMethod(const CIMName& name) const;

/** getMethod - Gets the method object defined by the

/** Gets the method object defined by the input parameter.

input parameter.

@param index Index to the method object to get.

@param pos Index to the method object to get

@return CIMMethod object of the method requested.

@return Returns handle of the method requested

@exception IndexOutOfBoundsException if the index is outside

@exception Throws OutofBounds if the index represented by pos is greater

the range of methods in this class.

than the number of methods defined in the class object

CIMMethod getMethod(Uint32 pos);

CIMMethod getMethod(Uint32 index);

/** getMethod Gets the method object defined by the input

/** Gets the method object defined by the input parameter.

parameter. This is the const version.

@param index Index to the method object to get.

@return CIMConstMethod object of the method requested.

@exception IndexOutOfBoundsException if the index is outside

the range of methods in this class.

CIMConstMethod getMethod(Uint32 index) const;

CIMConstMethod getMethod(Uint32 pos) const;

/** Removes the method defined by the index parameter.

@param index Defines the index of the method to be removed.

/** removeMethod - Removes the method defined by the

@exception IndexOutOfBoundsException if the index is outside

index parameter.

the range of methods in this class.

@param Defines the index of the method to be removed.

@return There is no return.

@exception Throw OutOfBound exception if the index is outside

the range of existing method objects for this class

void removeMethod(Uint32 pos);

void removeMethod(Uint32 index);

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

/** Gets the count of the number of methods in the class.

@return integer representing the number of methods in the class object.

@return the count of the number of methods in the class object.

Uint32 getMethodCount() const;

/** Get names of all keys of this class. */

/// Get names of all keys of this class.

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

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

/** Determines if the object has keys.

@return true if the object has keys, false otherwise.

Boolean hasKeys() const;

/** Makes a deep copy (clone) of the given object. */

/** Makes a deep copy (clone) of the given object.

@return copy of the CIMClass object.

CIMClass clone() const;

// ATTN: Clarify exactly what identical means

/** Compares with another CIM class.

/** identical - Compares with another class

@param x Class object for the class to be compared.

@param Class object for the class to be compared

@return true if the classes are identical, false otherwise.

@return True if the classes are identical

Boolean identical(const CIMConstClass& x) const;

#ifdef PEGASUS_INTERNALONLY

/** Determines if the object has not been initialized.

// ATTN: explain why this here

@return true if the object has not been initialized,

/** Resolve - Resolve the class: inherit any properties and

false otherwise.

qualifiers. Make sure the superClass really exists and is consistent

with this class. Also set the propagated flag class-origin for each

Boolean isUninitialized() const;

class feature.

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

void resolve(

/** Experimental Interface

DeclContext* declContext,

Build a CIMInstance based on this CIM Class. Properties in the instance

const String& nameSpace);

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.

// isNull - ATTN:

@return CIMInstance of this class appropriately initialized.

Boolean isNull() const;

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>

CIMInstance buildInstance(Boolean includeQualifiers,

Boolean includeClassOrigin,

const CIMPropertyList & propertyList) const;

#endif

private:

Line 335

Line 361

friend class CIMConstClass;

friend class CIMObject;

friend class CIMConstObject;

friend class Resolver;

friend class XmlWriter;

friend class MofWriter;

friend class BinaryStreamer;

};

#define PEGASUS_ARRAY_T CIMClass

#include <Pegasus/Common/ArrayInter.h>

#undef PEGASUS_ARRAY_T

// ATTN document this

/// CIMConstClass

/** CIMConstClass

class PEGASUS_COMMON_LINKAGE CIMConstClass

{

public:

///

CIMConstClass();

///

CIMConstClass(const CIMConstClass& x);

///

CIMConstClass(const CIMClass& x);

PEGASUS_EXPLICIT CIMConstClass(const CIMObject& x)

///

throw(DynamicCastFailed);

PEGASUS_EXPLICIT CIMConstClass(const CIMObject& x);

PEGASUS_EXPLICIT CIMConstClass(const CIMConstObject& x)

///

throw(DynamicCastFailed);

PEGASUS_EXPLICIT CIMConstClass(const CIMConstObject& x);

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

///

CIMConstClass(

const CIMObjectPath& reference,

const CIMName& className,

const String& superClassName = String::EMPTY);

const CIMName& superClassName = CIMName());

///

CIMConstClass& operator=(const CIMConstClass& x);

///

CIMConstClass& operator=(const CIMClass& x);

///

~CIMConstClass();

///

Boolean isAssociation() const;

///

Boolean isAbstract() const;

const String& getClassName() const;

///

const CIMName& getClassName() const;

///

const CIMObjectPath& getPath() const;

const String& getSuperClassName() const;

///

const CIMName& getSuperClassName() const;

Uint32 findQualifier(const String& name) const;

CIMConstQualifier getQualifier(Uint32 pos) const;

///

Uint32 findQualifier(const CIMName& name) const;

Boolean isTrueQualifier(const String& name) const;

///

CIMConstQualifier getQualifier(Uint32 index) const;

///

Uint32 getQualifierCount() const;

Uint32 findProperty(const String& name) const;

///

Uint32 findProperty(const CIMName& name) const;

CIMConstProperty getProperty(Uint32 pos) const;

///

CIMConstProperty getProperty(Uint32 index) const;

///

Uint32 getPropertyCount() const;

Uint32 findMethod(const String& name) const;

///

Uint32 findMethod(const CIMName& name) const;

CIMConstMethod getMethod(Uint32 pos) const;

///

CIMConstMethod getMethod(Uint32 index) const;

///

Uint32 getMethodCount() const;

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

///

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

///

Boolean hasKeys() const;

///

CIMClass clone() const;

///

Boolean identical(const CIMConstClass& x) const;

#ifdef PEGASUS_INTERNALONLY

///

Boolean isNull() const;

Boolean isUninitialized() const;

#endif

private:

Line 428

Line 475

friend class CIMConstObject;

friend class XmlWriter;

friend class MofWriter;

friend class BinaryStreamer;

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.50
changed lines
	Added in v.1.72

No CVS admin address has been configured