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.28 and 1.47

version 1.28, 2002/06/01 00:56:25

version 1.47, 2007/10/19 18:22:02

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_Object_h

#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 46

Line 50

class CIMConstClass;

class CIMInstance;

class CIMConstInstance;

class CIMProperty;

class CIMConstProperty;

class CIMQualifier;

class CIMConstQualifier;

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

Line 53

Line 61

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

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

/**

The CIMObject class represents the DMTF standard CIM object definition,

which may represent a CIMClass or a CIMInstance.

The CIMObjectRep data member points to either a CIMInstanceRep or

<p>The CIMObject class uses a shared representation model, such that

CIMClassRep.

multiple CIMObject 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 CIMObject object affects all the CIMObject

objects that refer to the same data copy. The data remains valid until

all the CIMObject objects that refer to it are destructed. A separate

copy of the data may be created using the clone method.

class PEGASUS_COMMON_LINKAGE CIMObject

{

public:

/** Constructor.

/**

Constructs an uninitialized CIMObject object. A method

invocation on an uninitialized object will result in the throwing

of an UninitializedObjectException. An uninitialized object may

be converted into an initialized object only by using the assignment

operator with an initialized object.

CIMObject();

/** Copy constructor.

/**

Constructs a CIMObject 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 a new

CIMObject object.

CIMObject(const CIMObject& x);

/** Construction from CIMClass.

/**

Constructs a CIMObject 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 the

CIMObject object.

CIMObject(const CIMClass& x);

/** Construction from CIMInstance.

/**

Constructs a CIMObject object from the value of a specified

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

@param x The CIMInstance object from which to construct the

CIMObject object.

CIMObject(const CIMInstance& x);

/** Assignment operator.

/**

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

so that both objects refer to the same data copy.

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

object.

@return A reference to this CIMObject object.

CIMObject& operator=(const CIMObject& x);

/** Assignment operator.

/**

Destructs the CIMObject object.

CIMObject& operator=(const CIMClass& x);

/** Assignment operator.

CIMObject& operator=(const CIMInstance& x);

/** Destructor.

~CIMObject();

/** Accessor for ClassName component of the object.

/**

@return - Returns the ClassName of the object in

Gets the class name of the object.

a String parameter.

@return A CIMName containing the class name.

<pre>

@exception UninitializedObjectException If the object is not

String className;

initialized.

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

className = myclass.getClassName;

</pre>

const String& getClassName() const;

const CIMName& getClassName() const;

/**

Gets the object path for the object.

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

Sets the object path for the object.

@param path CIMObjectPath containing the object path

@param path A CIMObjectPath containing the object path.

@exception UninitializedObjectException If the object is not

initialized.

void setPath (const CIMObjectPath & path);

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

/**

Thows an exception of the CIMQualifier already exists in the instance

Adds a qualifier to the object.

@param CIMQualifier object to add to instance

@param qualifier The CIMQualifier to be added.

@return ATTN:

@return A reference to this CIMObject object.

@exception Throws AlreadyExists.

@exception AlreadyExistsException If a qualifier with the

same name already exists in the CIMObject.

@exception UninitializedObjectException If the object is not

initialized.

CIMObject& addQualifier(const CIMQualifier& qualifier);

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

/**

defined by the input parameter.

Finds a qualifier by name.

@param String defining the qualifier object to be found.

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

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

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

operations or PEG_NOT_FOUND if the qualifier is not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findQualifier(const String& name) const;

Uint32 findQualifier(const CIMName& name) const;

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

defined by the input parameter.

/**

@param String defining the qualifier object to be found.

Gets the qualifier at the specified index.

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

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

if the qualifier is not found.

@return The CIMQualifier at the specified index.

@exception IndexOutOfBoundsException If the index is outside

Boolean existsQualifier(const String& name) const;

the range of qualifiers available for the CIMObject.

@exception UninitializedObjectException If the object is not

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

initialized.

index input parameter. @ index for the qualifier object.

The index to qualifier objects is zero-origin and continuous

CIMQualifier getQualifier(Uint32 index);

so that incrementing loops can be used to get all qualifier

objects in a CIMInstnace.

/**

@return: Returns qualifier object defined by index.

Gets the qualifier at the specified index.

@exception Throws the OutOfBounds exception if the index

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

is out of bounds

@return The CIMConstQualifier at the specified index.

@exception IndexOutOfBoundsException If the index is outside

CIMQualifier getQualifier(Uint32 pos);

the range of qualifiers available for the CIMObject.

@exception UninitializedObjectException If the object is not

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

initialized.

index input parameter. @ index for the qualifier object.

The index to qualifier objects is zero-origin and continuous

CIMConstQualifier getQualifier(Uint32 index) const;

so that incrementing loops can be used to get all qualifier

objects in a CIMInstnace.

/**

@return: Returns qualifier object defined by index.

Removes a qualifier from the object.

@exception Throws the OutOfBounds exception if the index

@param index The index of the qualifier to remove.

is out of bounds

@exception IndexOutOfBoundsException If the index is

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

outside the range of qualifiers available for the CIMObject.

ATTN: Is the above statement correct???

@exception UninitializedObjectException If the object is not

initialized.

CIMConstQualifier getQualifier(Uint32 pos) const;

void removeQualifier(Uint32 index);

void removeQualifier(Uint32 pos);

/**

/** getQualifierCount - Gets the number of CIMQualifier objects

Gets the number of qualifiers in the object.

defined for this CIMObject.

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

@return Count of the number of CIMQualifier objects in the

@exception UninitializedObjectException If the object is not

CIMObject.

initialized.

@exception Throws the OutOfBounds exception if the index

is out of bounds

Uint32 getQualifierCount() const;

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

/**

parameter to the CIMObject

Adds a property to the object.

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

@param x The CIMProperty to be added.

class for definition of the property object

@return A reference to this CIMObject object.

@return ATTN:

@exception AlreadyExistsException If a property with the

@exception Throws the exception AlreadyExists if the property

same name already exists in the CIMObject.

already exists.

@exception UninitializedObjectException If the object is not

initialized.

CIMObject& addProperty(const CIMProperty& x);

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

/**

CIMObject for property objects with the name defined by the

Finds a property by name.

input.

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

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

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

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

@exception UninitializedObjectException If the object is not

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

initialized.

input.

Uint32 findProperty(const CIMName& name) const;

Uint32 findProperty(const String& name) const;

/**

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

Gets the property at the specified index.

name defined by the input parameter exists in the class.

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

@parm String parameter with the property name.

@return The CIMProperty at the specified index.

@return True if the property object exists.

@exception IndexOutOfBoundsException If the index is outside

the range of properties available for the CIMObject.

Boolean existsProperty(const String& name) const;

@exception UninitializedObjectException If the object is not

initialized.

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

by the input index parameter.

CIMProperty getProperty(Uint32 index);

@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

Gets the property at the specified index.

objects in a CIMObject.

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

@return CIMProperty object corresponding to the index.

@return The CIMConstProperty at the specified index.

@exception Throws the OutOfBounds exception if the index

@exception IndexOutOfBoundsException If the index is outside

is out of bounds

the range of properties available for the CIMObject.

@exception UninitializedObjectException If the object is not

ATTN: What is the effect of out of range?

initialized.

CIMProperty getProperty(Uint32 pos);

CIMConstProperty getProperty(Uint32 index) const;

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

/**

by the input index parameter.

Removes a property from the object.

@param Index to the property object in the CIMObject.

@param index The index of the property to remove.

The index to qualifier objects is zero-origin and continuous

@exception IndexOutOfBoundsException If the index is

so that incrementing loops can be used to get all qualifier

outside the range of properties available for the CIMObject.

objects in a CIMInstnace.

@exception UninitializedObjectException If the object is not

@return CIMProperty object corresponding to the index.

initialized.

@exception Throws the OutOfBounds exception if the index

is out of bounds

void removeProperty(Uint32 index);

ATTN: What is the effect of out of range?

CIMConstProperty getProperty(Uint32 pos) const;

/** removeProperty - Removes the property represented

by the position input parameter from the instance.

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

instance. Normally this is obtained by getProperty();

@exception Throws OutofBounds if index is not a property object

void removeProperty(Uint32 pos);

/** getPropertyCount - Gets the number of CIMProperty

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

@exception Throws the OutOfBounds exception if the index

is out of bounds

/**

Gets the number of properties in the object.

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

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getPropertyCount() const;

/** Clones the given object.

/**

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

the object attributes including qualifiers and properties.

@return A new copy of the CIMObject object.

@exception UninitializedObjectException If the object is not

initialized.

CIMObject clone() const;

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

/**

Compares the CIMObject with a specified CIMConstObject.

@param x The CIMConstObject to be compared.

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

false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean identical(const CIMConstObject& x) const;

#ifdef PEGASUS_INTERNALONLY

/**

/** isNull() - ATTN: */

Determines whether the object has been initialized.

Boolean isNull() const;

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

#endif

Boolean isUninitialized() const;

/**

Generates a human-readable String representing the value of the

CIMObject. The String may be in MOF format, but the format is not

guaranteed and may change without notice.

@return A human-readable String representing the CIMObject value.

@exception UninitializedObjectException If the object is not

initialized.

String toString() const;

/**

Indicates whether the object represents a CIMClass.

@return True if the object represents a CIMClass; false otherwise.

Boolean isClass() const;

/**

Indicates whether the object represents a CIMInstance.

@return True if the object represents a CIMInstance; false otherwise.

Boolean isInstance() const;

private:

CIMObjectRep* _rep;

#ifdef PEGASUS_INTERNALONLY

CIMObject(CIMObjectRep* rep);

void _checkRep() const;

friend class CIMConstObject;

friend class CIMClass;

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

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

/**

The CIMConstObject class provides a const interface to a CIMObject

object. This class is needed because the shared representation model

used by CIMObject does not prevent modification to a const CIMObject

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

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

class PEGASUS_COMMON_LINKAGE CIMConstObject

{

public:

/**

Constructs an uninitialized CIMConstObject object. A method

invocation on an uninitialized object will result in the throwing

of an UninitializedObjectException. An uninitialized object may

be converted into an initialized object only by using the assignment

operator with an initialized object.

CIMConstObject();

/**

Constructs a CIMConstObject 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 a new

CIMConstObject object.

CIMConstObject(const CIMConstObject& x);

/**

Constructs a CIMConstObject 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 a new

CIMConstObject object.

CIMConstObject(const CIMObject& x);

/** Construction from CIMClass.

/**

Constructs a CIMConstObject 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 the

CIMConstObject object.

CIMConstObject(const CIMClass& x);

/** Construction from CIMInstance.

/**

Constructs a CIMConstObject object from the value of a specified

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

@param x The CIMInstance object from which to construct the

CIMConstObject object.

CIMConstObject(const CIMInstance& x);

/** Construction from CIMClass.

/**

Constructs a CIMConstObject 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 the

CIMConstObject object.

CIMConstObject(const CIMConstClass& x);

/** Construction from CIMInstance.

/**

Constructs a CIMConstObject object from the value of a specified

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

copy.

@param x The CIMConstInstance object from which to construct the

CIMConstObject object.

CIMConstObject(const CIMConstInstance& x);

/**

Assigns the value of the specified CIMConstObject object to this

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

@param x The CIMConstObject object from which to assign this

CIMConstObject object.

@return A reference to this CIMConstObject object.

CIMConstObject& operator=(const CIMConstObject& x);

CIMConstObject& operator=(const CIMObject& x);

/**

Destructs the CIMConstObject object.

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;

/**

Gets the class name of the object.

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

@return A CIMObjectPath containing the object path.

@exception UninitializedObjectException If the object is not

initialized.

const CIMObjectPath& getPath() const;

Uint32 findQualifier(const String& name) 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;

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

@exception UninitializedObjectException If the object is not

initialized.

CIMConstQualifier getQualifier(Uint32 index) const;

/**

Gets the number of qualifiers in the object.

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

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getQualifierCount() const;

Uint32 findProperty(const String& name) 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;

CIMConstProperty getProperty(Uint32 pos) 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 CIMConstObject.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstProperty getProperty(Uint32 index) const;

/**

Gets the number of properties in the object.

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

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getPropertyCount() const;

/**

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

the object attributes including qualifiers and properties.

@return A CIMObject object with a separate copy of the

CIMConstObject object.

@exception UninitializedObjectException If the object is not

initialized.

CIMObject clone() const;

/**

Compares the CIMConstObject with a specified CIMConstObject.

@param x The CIMConstObject to be compared.

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

false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean identical(const CIMConstObject& x) const;

#ifdef PEGASUS_INTERNALONLY

/**

Boolean isNull() const;

Determines whether the object has been initialized.

#endif

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

Boolean isUninitialized() const;

/**

Generates a human-readable String representing the value of the

CIMObject. The String may be in MOF format, but the format is not

guaranteed and may change without notice.

@return A human-readable String representing the CIMObject value.

@exception UninitializedObjectException If the object is not

initialized.

String toString () const;

/**

Indicates whether the object represents a CIMConstClass.

@return True if the object represents a CIMConstClass; false otherwise.

Boolean isClass() const;

/**

Indicates whether the object represents a CIMConstInstance.

@return True if the object represents a CIMConstInstance; false

otherwise.

Boolean isInstance() const;

private:

CIMObjectRep* _rep;

#ifdef PEGASUS_INTERNALONLY

void _checkRep() const;

friend class CIMObject;

friend class CIMClass;

friend class CIMConstClass;

friend class CIMInstance;

friend class CIMConstInstance;

#endif

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.28
changed lines
	Added in v.1.47

No CVS admin address has been configured