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

Return to CIMObject.h CVS log

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

Diff for /pegasus/src/Pegasus/Common/CIMObject.h between version 1.18 and 1.39

version 1.18, 2002/05/03 05:16:16

version 1.39, 2003/10/22 14:26:02

Line 1

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

//%2003////////////////////////////////////////////////////////////////////////

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

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

Line 22

Line 25

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By:

// Modified By: Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)

// Carol Ann Krug Graves, Hewlett-Packard Company

// (carolann_graves@hp.com)

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

Line 30

Line 35

#define Pegasus_Object_h

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/String.h>

#include <Pegasus/Common/CIMName.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/Common/CIMProperty.h>

#include <Pegasus/Common/CIMQualifier.h>

Line 50

Line 57

////////////////////////////////////////////////////////////////////////////////

/** This class either refers to a CIMInstance or a CIMClass.

/** The CIMObject class is the superclass for the CIMInstance and

CIMClass classes.

The CIMObjectRep data member points to either a CIMInstanceRep or

CIMClassRep.

Line 79

Line 87

CIMObject& operator=(const CIMObject& x);

/** Assignment operator.

CIMObject& operator=(const CIMClass& x);

/** Assignment operator.

CIMObject& operator=(const CIMInstance& x);

/** Destructor.

~CIMObject();

/** Accessor for ClassName component of the object.

/** Gets the ClassName of the object.

@return - Returns the ClassName of the object in

@return ClassName of the object in a CIMName parameter.

a String parameter.

<pre>

String className;

CIMName className;

CIMClass myclass("myclass", "superclass");

className = myclass.getClassName;

</pre>

const String& getClassName() const;

const CIMName& getClassName() const;

/** equalClassName Compares ClassName with a String. This test performs

///

a comparison of the classname component of the object

const CIMObjectPath& getPath() const;

with a String. Note that this function was included specifically

because the equality compare is not just a straight comparison

because classnames are case independent.

@param classname String containing the name for comparison

@return True if it is the same class name (equalNoCase compare passes)

or false if not.

const Boolean equalClassName(const String& classname) const;

const CIMReference& getPath() const;

/** addQualifier - Adds the CIMQualifier object to the instance.

Thows an exception of the CIMQualifier already exists in the instance

@param CIMQualifier object to add to instance

@return ATTN:

@exception Throws AlreadyExists.

CIMObject& addQualifier(const CIMQualifier& qualifier);

/** findQualifier - Searches the instance for the qualifier object

/** Sets the object path for the object.

defined by the input parameter.

@param path - CIMObjectPath containing the object path.

@param String defining the qualifier object to be found.

@return - Position of the qualifier to be used in subsequent

operations or PEG_NOT_FOUND if the qualifier is not found.

Uint32 findQualifier(const String& name) const;

void setPath (const CIMObjectPath & path);

/** existsQualifier - Searches the instance for the qualifier object

/** Adds the CIMQualifier object to the instance.

defined by the input parameter.

@param qualifier - CIMQualifier object to add to instance.

@param String defining the qualifier object to be found.

@return the resulting CIMObject.

@return - Returns True if the qualifier object exists or false

@exception AlreadyExistsException if the CIMQualifier already

if the qualifier is not found.

exists in the instance.

Boolean existsQualifier(const String& name) const;

CIMObject& addQualifier(const CIMQualifier& qualifier);

/** getQualifier - Retrieves the qualifier object defined by the

/** Searches the instance for the qualifier object

index input parameter. @ index for the qualifier object.

defined by the input parameter.

The index to qualifier objects is zero-origin and continuous

@param name - CIMName defining the qualifier object to be found.

so that incrementing loops can be used to get all qualifier

@return Position of the qualifier to be used in subsequent

objects in a CIMInstnace.

operations or PEG_NOT_FOUND if the qualifier is not found.

@return: Returns qualifier object defined by index.

@exception Throws the OutOfBounds exception if the index

is out of bounds

CIMQualifier getQualifier(Uint32 pos);

Uint32 findQualifier(const CIMName& name) const;

/** getQualifier - Retrieves the qualifier object defined by the

/** Retrieves the qualifier object defined by the input parameter.

index input parameter. @ index for the qualifier object.

@param index - Index for the qualifier object. The index to

The index to qualifier objects is zero-origin and continuous

qualifier objects is zero-origin and continuous so that

so that incrementing loops can be used to get all qualifier

incrementing loops can be used to get all qualifier

objects in a CIMInstnace.

objects in a CIMInstance.

@return: Returns qualifier object defined by index.

@return CIMQualifier object defined by the index.

@exception Throws the OutOfBounds exception if the index

@exception IndexOutOfBoundsException exception if the index

is out of bounds

is out of bounds.

ATTN: What is effect of out of range index???

ATTN: Is the above statement correct???

CIMQualifier getQualifier(Uint32 index);

/** Retrieves the qualifier object defined by the input parameter.

@param index - Index for the qualifier object. The index to

qualifier objects is zero-origin and continuous so that

incrementing loops can be used to get all qualifier

objects in a CIMInstance.

@return CIMConstQualifier object defined by the index.

@exception IndexOutOfBoundsException exception if the index

is out of bounds.

CIMConstQualifier getQualifier(Uint32 pos) const;

CIMConstQualifier getQualifier(Uint32 index) const;

void removeQualifier(Uint32 pos);

///

void removeQualifier(Uint32 index);

/** getQualifierCount - Gets the number of CIMQualifier objects

/** Gets the number of CIMQualifier objects defined for

defined for this CIMObject.

this CIMObject.

@return Count of the number of CIMQualifier objects in the

CIMObject.

@exception Throws the OutOfBounds exception if the index

is out of bounds

Uint32 getQualifierCount() const;

/** addProperty - Adds a property object defined by the input

/** Adds a property object defined by the input parameter to

parameter to the CIMObject

the CIMObject.

@param Property Object to be added. See the CIM Property

@param x - Property Object to be added. See the CIM Property

class for definition of the property object

class for definition of the property object.

@return ATTN:

@return the resulting CIMObject.

@exception Throws the exception AlreadyExists if the property

@exception AlreadyExistsException if the property already exists.

already exists.

CIMObject& addProperty(const CIMProperty& x);

/** findProperty - Searches the CIMProperty objects installed in the

/** Searches the CIMProperty objects in the

CIMObject for property objects with the name defined by the

CIMObject for a property object with the name defined by the

input.

input parameter.

@param String with the name of the property object to be found

@param name - CIMName with the name of the property object to be found.

@return Position in the CIM object to the property object if found or

@return Position in the CIM object of the property object if found or

PEG_NOT_FOUND if no property object found with the name defined by the

input.

input parameter.

Uint32 findProperty(const String& name) const;

Uint32 findProperty(const CIMName& name) const;

/** existsProperty - Determines if a property object with the

/** Gets the CIMProperty object in the CIMObject defined

name defined by the input parameter exists in the class.

by the input parameter.

@parm String parameter with the property name.

@param index - Index to the property object in the CIMObject.

@return True if the property object exists.

Boolean existsProperty(const String& name) const;

/** getProperty - Gets the CIMProperty object in the CIMObject defined

by the input index parameter.

@param Index to the property object in the CIMObject.

The index to qualifier objects is zero-origin and continuous

so that incrementing loops can be used to get all qualifier

objects in a CIMObject.

@return CIMProperty object corresponding to the index.

@exception Throws the OutOfBounds exception if the index

@exception IndexOutOfBoundsException exception if the index

is out of bounds

is out of bounds.

ATTN: What is the effect of out of range?

CIMProperty getProperty(Uint32 pos);

CIMProperty getProperty(Uint32 index);

/** getProperty - Gets the CIMproperty object in the CIMObject defined

/** Gets the CIMproperty object in the CIMObject defined

by the input index parameter.

by the input parameter.

@param Index to the property object in the CIMObject.

@param index - Index to the property object in the CIMObject.

The index to qualifier objects is zero-origin and continuous

so that incrementing loops can be used to get all qualifier

objects in a CIMInstnace.

@return CIMProperty object corresponding to the index.

@exception Throws the OutOfBounds exception if the index

@exception IndexOutOfBoundsException if the index is outside the

is out of bounds

range of properties in this object.

ATTN: What is the effect of out of range?

CIMConstProperty getProperty(Uint32 pos) const;

CIMConstProperty getProperty(Uint32 index) const;

/** removeProperty - Removes the property represented

/** Remove the specified property from the instance.

by the position input parameter from the instance.

@param index - Index to the property to be removed from the

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

instance. Normally this is obtained by findProperty();

instance. Normally this is obtained by getProperty();

@exception IndexOutOfBoundsException if the index is outside the

@exception Throws OutofBounds if index is not a property object

range of properties in this object.

void removeProperty(Uint32 pos);

void removeProperty(Uint32 index);

/** getPropertyCount - Gets the number of CIMProperty

/** Gets the number of CIMProperty objects defined for this CIMObject.

objects defined for this CIMObject.

@return Count of the number of CIMProperty objects in the

CIMObject. Zero indicates that no CIMProperty objects

are contained in the CIMObject

are contained in the CIMObject.

@exception Throws the OutOfBounds exception if the index

is out of bounds

Uint32 getPropertyCount() const;

/** Clones the given object.

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

@return copy of the CIMObject.

CIMObject clone() const;

/** Returns true if the two classes are structurally identical.

/** Compares with another CIM Object.

@param x - CIM object for comparision.

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

Boolean identical(const CIMConstObject& x) const;

#ifdef PEGASUS_INTERNALONLY

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

/** operator int() - ATTN: */

@return true if the object has not been initialized,

operator int() const;

false otherwise.

Boolean isUninitialized() const;

/** Determines if the object represents a CIMClass.

@return true if the object represents a CIMClass,

false otherwise.

Boolean isClass () const;

/** Convert object to XML format.

/** Determines if the object represents a CIMInstance.

@return true if the object represents a CIMInstance,

false otherwise

void toXml(Array<Sint8>& out) const;

Boolean isInstance () const;

#endif

private:

CIMObjectRep* _rep;

#ifdef PEGASUS_INTERNALONLY

CIMObject(CIMObjectRep* rep);

void _checkRep() const;

Line 279

Line 254

friend class CIMConstClass;

friend class CIMInstance;

friend class CIMConstInstance;

#endif

};

#define PEGASUS_ARRAY_T CIMObject

# include <Pegasus/Common/ArrayInter.h>

#undef PEGASUS_ARRAY_T

////////////////////////////////////////////////////////////////////////////////

// CIMConstObject

////////////////////////////////////////////////////////////////////////////////

///

class PEGASUS_COMMON_LINKAGE CIMConstObject

{

public:

///

CIMConstObject();

///

CIMConstObject(const CIMConstObject& x);

///

CIMConstObject(const CIMObject& x);

/** Construction from CIMClass.

/** Constructs a CIMObject instance from a CIMClass instance.

CIMConstObject(const CIMClass& x);

/** Construction from CIMInstance.

/** Constructs a CIMObject instance from a CIMInstance instance.

CIMConstObject(const CIMInstance& x);

/** Construction from CIMClass.

/** Constructs a CIMObject instance from a CIMConstClass instance.

CIMConstObject(const CIMConstClass& x);

/** Construction from CIMInstance.

/** Constructs a CIMObject instance from a CIMConstInstance instance.

CIMConstObject(const CIMConstInstance& x);

///

CIMConstObject& operator=(const CIMConstObject& x);

CIMConstObject& operator=(const CIMObject& x);

///

CIMConstObject& operator=(const CIMClass& x);

CIMConstObject& operator=(const CIMConstClass& x);

CIMConstObject& operator=(const CIMInstance& x);

CIMConstObject& operator=(const CIMConstInstance& x);

~CIMConstObject();

const String& getClassName() const;

///

const CIMName& getClassName() const;

const CIMReference& getPath() const;

///

const CIMObjectPath& getPath() const;

Uint32 findQualifier(const String& name) const;

///

Uint32 findQualifier(const CIMName& name) const;

CIMConstQualifier getQualifier(Uint32 pos) 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;

///

CIMObject clone() const;

///

Boolean identical(const CIMConstObject& x) const;

#ifdef PEGASUS_INTERNALONLY

///

operator int() const;

Boolean isUninitialized() const;

void toXml(Array<Sint8>& out) const;

///

Boolean isClass() const;

void print(PEGASUS_STD(ostream) &o=PEGASUS_STD(cout)) const;

///

#endif

Boolean isInstance() const;

private:

CIMObjectRep* _rep;

#ifdef PEGASUS_INTERNALONLY

void _checkRep() const;

friend class CIMObject;

Line 368

Line 352

friend class CIMConstClass;

friend class CIMInstance;

friend class CIMConstInstance;

#endif

};

/** The CIMObjectWithPath encapsulates a CIMReference and CIMObject.

Accessors are provided for getting the two parts. Constructors are

provided for initializing it from a CIMObject.

class PEGASUS_COMMON_LINKAGE CIMObjectWithPath

{

public:

/** Constructor

CIMObjectWithPath();

/** constructor

CIMObjectWithPath(const CIMReference& reference, const CIMObject& object);

/** Constructor - Constructs a CIMObjectWithPath Object from

another CimObjectWithPath

@param - ATTN

CIMObjectWithPath(const CIMObjectWithPath& x);

~CIMObjectWithPath();

CIMObjectWithPath& operator=(const CIMObjectWithPath& x);

/** set -

void set(const CIMReference& reference, const CIMObject& object);

/**

const CIMReference& getReference() const;

/**

const CIMObject& getObject() const;

/**

CIMReference& getReference();

/**

CIMObject& getObject();

#ifdef PEGASUS_INTERNALONLY

/**

void toXml(Array<Sint8>& out) const;

#endif

private:

CIMReference _reference;

CIMObject _object;

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.18
changed lines
	Added in v.1.39

No CVS admin address has been configured