(file) Return to SCMOInstance.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/SCMOInstance.h between version 1.1.2.16 and 1.1.2.32

version 1.1.2.16, 2009/09/29 15:11:51 version 1.1.2.32, 2009/11/03 13:11:51
Line 43 
Line 43 
  
 #define PEGASUS_SCMB_INSTANCE_MAGIC 0xD00D1234 #define PEGASUS_SCMB_INSTANCE_MAGIC 0xD00D1234
  
 class SCMOClass;  
   
 class PEGASUS_COMMON_LINKAGE SCMOInstance class PEGASUS_COMMON_LINKAGE SCMOInstance
 { {
 public: public:
  
     /**     /**
        * A SCMOInstance can only be created by a SCMOClass
        */
       SCMOInstance();
   
       /**
      * Creating a SCMOInstance using a SCMOClass.      * Creating a SCMOInstance using a SCMOClass.
      * @param baseClass A SCMOClass.      * @param baseClass A SCMOClass.
      */      */
     SCMOInstance(SCMOClass baseClass);      SCMOInstance(SCMOClass& baseClass);
   
   
       /**
        * Creating a SCMOInstance using a CIMClass
        * using an optional name space name,
        * @param baseClass A SCMOClass.
        * @param nameSpaceName An optional name space name.
        */
       SCMOInstance(CIMClass& theCIMClass, const char* nameSpaceName=0);
  
     /**     /**
      * Copy constructor for the SCMO instance, used to implement refcounting.      * Copy constructor for the SCMO instance, used to implement refcounting.
Line 97 
Line 109 
      *      *
      */      */
     SCMOInstance(     SCMOInstance(
         SCMOClass baseClass,          SCMOClass& baseClass,
         Boolean includeQualifiers,         Boolean includeQualifiers,
         Boolean includeClassOrigin,         Boolean includeClassOrigin,
         const char** propertyList);         const char** propertyList);
Line 107 
Line 119 
      * CIMInstance data into the new SCMOInstance.      * CIMInstance data into the new SCMOInstance.
      * @param baseClass The SCMOClass of this instance.      * @param baseClass The SCMOClass of this instance.
      * @param cimInstance A CIMInstace of the same class.      * @param cimInstance A CIMInstace of the same class.
      * @exception Exception if class name and name space does not match.       * @exception Exception if class name does not match.
      * @exception  
      *     Exception if CIMInstance has more key bindings then the SCMOClass.  
      * @exception  
      *     Exception if a key binding is not found as a key property  
      *     of the SCMOClass.  
      * @exception Exception if a key binding does not match  
      *     the class definition.  
      * @exception Exception if a property is not part of class definition.      * @exception Exception if a property is not part of class definition.
      * @exception Exception if a property does not match the class definition.      * @exception Exception if a property does not match the class definition.
      */      */
     SCMOInstance(SCMOClass baseClass, const CIMInstance& cimInstance);      SCMOInstance(SCMOClass& baseClass, const CIMInstance& cimInstance);
  
     /**     /**
      * Builds a SCMOInstance from the given SCMOClass and copies all      * Builds a SCMOInstance from the given SCMOClass and copies all
      * CIMObjectPath data into the new SCMOInstance.      * CIMObjectPath data into the new SCMOInstance.
      * @param baseClass The SCMOClass of this instance.      * @param baseClass The SCMOClass of this instance.
      * @param cimInstance A CIMObjectpath of the same class.      * @param cimInstance A CIMObjectpath of the same class.
      * @exception Exception if class name and name space does not match.       * @exception Exception if class name does not match.
      * @exception       */
      *     Exception if CIMInstance has more key bindings then the SCMOClass.      SCMOInstance(SCMOClass& baseClass, const CIMObjectPath& cimObj);
      * @exception  
      *     Exception if a key binding is not found as a key property      /**
      *     of the SCMOClass.       * Builds a SCMOInstance from the given CIMInstance copying all data.
      * @exception Exception if a key binding does not match       * The SCMOClass is retrieved from SCMOClassCache using
      *     the class definition.       * the class and name space of the CIMInstance.
        * If the SCMOClass was not found, an empty SCMOInstance will be returned
        * and the resulting SCMOInstance is compromized.
        * If the CIMInstance does not contain a name space, the optional fall back
        * name space is used.
        * @param cimInstance A CIMInstace with class name and name space.
        * @param altNameSpace An alternative name space name.
        * @exception Exception if a property is not part of class definition.
        * @exception Exception if a property does not match the class definition.
      */      */
     SCMOInstance(SCMOClass baseClass, const CIMObjectPath& cimObj);      SCMOInstance(
           const CIMInstance& cimInstance,
           const char* altNameSpace=0,
           Uint64 altNSLen=0);
   
       /**
        * Builds a SCMOInstance from the given CIMObjectPath copying all data.
        * The SCMOClass is retrieved from SCMOClassCache using
        * the class and name space of the CIMObjectPath.
        * If the SCMOClass was not found, an empty SCMOInstance will be returned
        * and the resulting SCMOInstance is compromized.
        * If the CIMObjectPath does not contain a name space,
        * the optional fall back name space is used.
        * @param cimObj A CIMObjectpath with name space and name
        * @param altNameSpace An alternative name space name.
        * @
        */
       SCMOInstance(
           const CIMObjectPath& cimObj,
           const char* altNameSpace=0,
           Uint64 altNSLen=0);
   
       /**
        * Builds a SCMOInstance from the given CIMObject copying all data.
        * The SCMOClass is retrieved from SCMOClassCache using
        * the class and name space of the CIMObject.
        * If the SCMOClass was not found, an empty SCMOInstance will be returned
        * and the resulting SCMOInstance is compromized.
        * If the CIMInstance does not contain a name space, the optional fall back
        * name space is used.
        * @param cimInstance A CIMInstace with class name and name space.
        * @param altNameSpace An alternative name space name.
        * @exception Exception if a property is not part of class definition.
        * @exception Exception if a property does not match the class definition.
        */
       SCMOInstance(
           const CIMObject& cimObject,
           const char* altNameSpace=0,
           Uint64 altNSLen=0);
  
     /**     /**
      * Converts the SCMOInstance into a CIMInstance.      * Converts the SCMOInstance into a CIMInstance.
Line 212 
Line 263 
         Uint32& size ) const;         Uint32& size ) const;
  
     /**     /**
      * Gets the property name, type, and value addressed by a positional index.  
      * The property name and value has to be copied by the caller !  
      * @param pos The positional index of the property  
      * @param pname Returns the property name as '\0' terminated string.  
      *              Has to be copied by caller.  
      *              It is set to NULL if rc != SCMO_OK.  
      * @param value Returns an absolute pointer to the value of property.  
      *                  Sub-pointers are NOT resolved!  
      *               The value has to be copied by the caller !  
      *               It returns NULL if rc != SCMO_OK.  
      * @param valueBase Returns an absolute pointer to the base of value,  
      *                  because subsequent pointers in the value are NOT  
      *                  resolved.  
      * @param propDef Returns an absolute pointer to the property definition  
      *                  Sub-pointers are NOT resolved!  
      *             It is invalid if rc == SCMO_INDEX_OUT_OF_BOUND.  
      *  
      * @return     SCMO_OK  
      *             SCMO_NULL_VALUE : The value is a null value.  
      *             SCMO_INDEX_OUT_OF_BOUND : Given index not found  
      *  
      */  
     SCMO_RC getPropertyAt(  
         Uint32 pos,  
         SCMBValue** value,  
         const char ** valueBase,  
         SCMBClassProperty ** propDef) const;  
   
     /**  
      * Gets the type and value of the named property.      * Gets the type and value of the named property.
      * The value has to be copied by the caller !      * The value has to be copied by the caller !
      * @param name The property name      * @param name The property name
Line 456 
Line 478 
         const SCMBUnion* keyvalue);         const SCMBUnion* keyvalue);
  
     /**     /**
        * Clears all key bindings in an instance.
        * Warning: External references are freed but only the internal
        * control structures are resetted. No memory is freed and at setting
        * new key bindings the instance will grow in memory usage.
        **/
       void clearKeyBindings();
   
       /**
      * Gets the key binding count.      * Gets the key binding count.
      * @return the number of key bindings set.      * @return the number of key bindings set.
      */      */
Line 513 
Line 543 
         const SCMBUnion** keyvalue) const;         const SCMBUnion** keyvalue) const;
  
     /**     /**
      * Determines whether the object has been initialized.       * Determines whether the c++ object has been initialized.
      * @return True if the object has not been initialized, false otherwise.       * @return True if the c++ object has not been initialized, false otherwise.
        */
       Boolean isUninitialized( ) const {return (0 == inst.base); };
   
       /**
        * Determines if the SCMOInstance does not contain any property information.
        * Maybe only the class name and/or name space are available.
        * @return True if the SCMOInstacne is empty, false otherwise.
        */
       Boolean isEmpty( ) const {return (inst.hdr->theClass->isEmpty()); };
   
       /**
        * Determines whether the instance is used as a class container.
        * @return True if the instance is used as a class container only.
        */
       Boolean getIsClassOnly( ) const
       {
           return inst.hdr->flags.isClassOnly;
       }
   
       /**
        * To mark if this instance is a class only container.
      */      */
     Boolean isUninitialized( ) const {return (inst.base == NULL); };      void setIsClassOnly( Boolean b )
       {
           inst.hdr->flags.isClassOnly = b;
       }
  
     /**     /**
      * Determies if two objects are referencing to the same instance      * Determies if two objects are referencing to the same instance
Line 525 
Line 579 
     Boolean isSame(SCMOInstance& theInstance) const;     Boolean isSame(SCMOInstance& theInstance) const;
  
     /**     /**
        * Sets the provided host name at the instance.
        * @param hostName The host name as UTF8.
        */
       void setHostName(const char* hostName);
   
       /**
        * Sets the provided host name unchecked at the instance.
        * @param hostName The host name as UTF8.
        * @param len The strlen of the host name.
        */
       void setHostName_l(const char* hostName, Uint64 len);
   
       /**
      * Get the host name of the instance. The caller has to make a copy !      * Get the host name of the instance. The caller has to make a copy !
      * @return The host name as UTF8.      * @return The host name as UTF8.
      */      */
     const char* getHostName() const;     const char* getHostName() const;
  
     /**     /**
      * Sets the provided host name at the instance.       * Get the host name of the instance.
      * @param hostName The host name as UTF8.       * @param Return strlen of result string.
        * @return The class name as UTF8.
      */      */
     void setHostName(const char* hostName);      const char* getHostName_l(Uint64 & length) const;
   
       /**
        * Sets the provided class name at the instance. By caling this function
        * the instance is in an inconsitacne state and is maked as isCompromised.
        * @param className The class name as UTF8.
        */
       void setClassName(const char* className);
   
       /**
        * Sets the provided class name at the instance. By caling this function
        * the instance is in an inconsitacne state and is maked as isCompromised.
        * @param className The class name as UTF8.
        * @param len The strlen of the name space.
        */
       void setClassName_l(const char* className, Uint64 len);
  
     /**     /**
      * Get the class name of the instance. The caller has to make a copy !      * Get the class name of the instance. The caller has to make a copy !
Line 544 
Line 627 
  
     /**     /**
      * Get the class name of the instance. The caller has to make a copy !      * Get the class name of the instance. The caller has to make a copy !
      * @return The class name as UTF8. Return length of result string.       * @param lenght Return strlen of result string.
        * @return The class name as UTF8.
      */      */
     const char* getClassName_l(Uint64 & length) const;     const char* getClassName_l(Uint64 & length) const;
  
     /**     /**
        * Sets the provided name space name at the instance.
        * By caling this function the instance is in an inconsitacne state and
        * is maked as isCompromised.
        * @param nameSpaceName The name space name as UTF8.
        */
       void setNameSpace(const char* nameSpace);
   
       /**
        * Sets the provided name space name unchecked at the instance.
        * By caling this function the instance is in an inconsitacne state and
        * is maked as isCompromised.
        * @param nameSpaceName The name space name as UTF8.
        * @param len The strlen of the name space.
        */
       void setNameSpace_l(const char* nameSpace, Uint64 len);
   
       /**
      * Get the name space of the instance. The caller has to make a copy !      * Get the name space of the instance. The caller has to make a copy !
      * @return The name space as UTF8.      * @return The name space as UTF8.
      */      */
     const char* getNameSpace() const;     const char* getNameSpace() const;
  
     /**     /**
        * Get the class name of the instance. The caller has to make a copy !
        * @param Return strlen of result string.
        * @return The class name as UTF8.
        */
       const char* getNameSpace_l(Uint64 & length) const;
   
       /**
        * Is the name space or class name of the instance the origianl values
        * set by the used SCMOClass.
        * The class name and/or name space may differ with the associated class.
        * @return true if name space or class name was set manually by
        *          setNameSpace() or setClassName()
        */
       Boolean isCompromised() const
       {
           return inst.hdr->flags.isCompromised;
       };
   
   
       /**
        * Mark the instance as a non validated instance.
        */
       void markAsCompromised()
       {
           inst.hdr->flags.isCompromised = true;
       };
   
       /**
      *  To indicate the export processing ( eg. XMLWriter )      *  To indicate the export processing ( eg. XMLWriter )
      *  to include qualifiers for this instance.      *  to include qualifiers for this instance.
      */      */
Line 598 
Line 727 
         // printf("\ninst.hdr->refCount=%u\n",inst.hdr->refCount.get());         // printf("\ninst.hdr->refCount=%u\n",inst.hdr->refCount.get());
     };     };
  
     void Unref();      void Unref()
       {
           if (inst.hdr->refCount.decAndTestIfZero())
           {
               // printf("\ninst.hdr->refCount=%u\n",inst.hdr->refCount.get());
               // All external references has to be destroyed.
               _destroyExternalReferences();
               // The class has also be dereferenced.
               delete inst.hdr->theClass;
               free(inst.base);
               inst.base=NULL;
           }
           else
           {
               // printf("\ninst.hdr->refCount=%u\n",inst.hdr->refCount.get());
           }
   
       };
   
  
     void _destroyExternalReferences();     void _destroyExternalReferences();
  
     /**      void _destroyExternalKeyBindings();
      * A SCMOInstance can only be created by a SCMOClass  
      */      void _copyExternalReferences();
     SCMOInstance();  
  
     void _initSCMOInstance(SCMOClass* pClass);     void _initSCMOInstance(SCMOClass* pClass);
  
     void _setCIMInstance(const CIMInstance& cimInstance);     void _setCIMInstance(const CIMInstance& cimInstance);
  
       void _getPropertyAt(
           Uint32 pos,
           SCMBValue** value,
           const char ** valueBase,
           SCMBClassProperty ** propDef) const;
   
     SCMO_RC _getPropertyAtNodeIndex(     SCMO_RC _getPropertyAtNodeIndex(
         Uint32 pos,         Uint32 pos,
         const char** pname,         const char** pname,
Line 626 
Line 778 
         Boolean isArray,         Boolean isArray,
         Uint32 size);         Uint32 size);
  
     void _setCIMValueAtNodeIndex(Uint32 node, CIMValueRep* valRep);      void _setCIMValueAtNodeIndex(
           Uint32 node,
           CIMValueRep* valRep,
           CIMType realType);
  
     static void _getCIMValueFromSCMBUnion(     static void _getCIMValueFromSCMBUnion(
         CIMValue& cimV,         CIMValue& cimV,
Line 642 
Line 797 
         const SCMBValue& scmbV,         const SCMBValue& scmbV,
         const char * base);         const char * base);
  
       static SCMOClass _getSCMOClass(
           const CIMObjectPath& theCIMObj,
           const char* altNS,
           Uint64 altNSlength);
   
     CIMProperty _getCIMPropertyAtNodeIndex(Uint32 nodeIdx) const;     CIMProperty _getCIMPropertyAtNodeIndex(Uint32 nodeIdx) const;
  
     void _setCIMObjectPath(const CIMObjectPath& cimObj);     void _setCIMObjectPath(const CIMObjectPath& cimObj);
Line 664 
Line 824 
         Uint64 start,         Uint64 start,
         SCMBMgmt_Header** pmem,         SCMBMgmt_Header** pmem,
         CIMType type,         CIMType type,
           Uint64 startNS,
           Uint64 lenNS,
         Union& u);         Union& u);
  
     static void _setUnionArrayValue(     static void _setUnionArrayValue(
Line 671 
Line 833 
         SCMBMgmt_Header** pmem,         SCMBMgmt_Header** pmem,
         CIMType type,         CIMType type,
         Uint32& n,         Uint32& n,
           Uint64 startNS,
           Uint64 lenNS,
         Union& u);         Union& u);
  
     SCMO_RC _getKeyBindingDataAtNodeIndex(     SCMO_RC _getKeyBindingDataAtNodeIndex(
Line 696 
Line 860 
         const char * uBase,         const char * uBase,
         SCMBKeyBindingValue& keyData);         SCMBKeyBindingValue& keyData);
  
     SCMO_RC _setKeyBindingFromString(const char* name,String cimKeyBinding);      SCMO_RC _setKeyBindingFromString(
           const char* name,
           CIMType type,
           String cimKeyBinding);
   
       SCMBUserKeyBindingElement* _getUserDefinedKeyBinding(
           const char* name,
           Uint32 nameLen,
           CIMType type);
   
       void _setUserDefinedKeyBinding(
           SCMBUserKeyBindingElement& theInsertElement,
           char* elementBase);
       /**
        * Set a SCMO user defined key binding using the class CIM type tolerating
        * CIM key binding types converted to CIM types by fuction
        *  _CIMTypeFromKeyBindingType().
        *
        * @parm classType The type of the key binding in the class definition
        * @parm setType The type of the key binding to be set.
        * @param keyValue A pointer to the key binding to be set.
        * @param kbValue Out parameter, the SCMO keybinding to be set.
        *
        **/
       SCMO_RC _setKeyBindingTypeTolerate(
           CIMType classType,
           CIMType setType,
           const SCMBUnion* keyValue,
           SCMBKeyBindingValue& kbValue);
   
       CIMType _CIMTypeFromKeyBindingType(
           const char* key,
           CIMKeyBinding::Type t);
   
       SCMO_RC _getUserKeyBindingNodeIndex(Uint32& node, const char* name) const;
  
     Boolean _setCimKeyBindingStringToSCMOKeyBindigValue(      SCMBUserKeyBindingElement* _getUserDefinedKeyBindingAt(Uint32 index) const;
   
       Boolean _setCimKeyBindingStringToSCMOKeyBindingValue(
         const String& kbs,         const String& kbs,
         CIMType type,         CIMType type,
         SCMBKeyBindingValue& scmoKBV         SCMBKeyBindingValue& scmoKBV
Line 719 
Line 919 
     friend class SCMOXmlWriter;     friend class SCMOXmlWriter;
 }; };
  
   inline void SCMOInstance::_getPropertyAt(
       Uint32 pos,
       SCMBValue** value,
       const char ** valueBase,
       SCMBClassProperty ** propDef) const
   {
       Uint32 node;
       // is filtering on ?
       if (inst.hdr->flags.isFiltered)
       {
           // Get absolut pointer to property filter index map of the instance
           Uint32* propertyFilterIndexMap =
           (Uint32*)&(inst.base[inst.hdr->propertyFilterIndexMap.start]);
           // get the real node index of the property.
           node = propertyFilterIndexMap[pos];
       }
       else
       {
           // the index is used as node index.
           node = pos;
       }
   
       SCMBValue* theInstPropNodeArray =
           (SCMBValue*)&(inst.base[inst.hdr->propertyArray.start]);
   
       // create a pointer to property node array of the class.
       Uint64 idx = inst.hdr->theClass->cls.hdr->propertySet.nodeArray.start;
       SCMBClassPropertyNode* theClassPropNodeArray =
           (SCMBClassPropertyNode*)&(inst.hdr->theClass->cls.base)[idx];
   
       // return the absolute pointer to the property definition
       *propDef= &(theClassPropNodeArray[node].theProperty);
   
       // need check if property set or not, if not set use the default value
       if (theInstPropNodeArray[node].flags.isSet)
       {
           // return the absolute pointer to the property value in the instance
           *value = &(theInstPropNodeArray[node]);
           *valueBase = inst.base;
       }
       else
       {
           // return the absolute pointer to
           *value = &(theClassPropNodeArray[node].theProperty.defaultValue);
           *valueBase = inst.hdr->theClass->cls.base;
       }
   }
   
   #define PEGASUS_ARRAY_T SCMOInstance
   # include <Pegasus/Common/ArrayInter.h>
   #undef PEGASUS_ARRAY_T
  
 PEGASUS_NAMESPACE_END PEGASUS_NAMESPACE_END
  

Legend:
Removed from v.1.1.2.16  
changed lines
  Added in v.1.1.2.32
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2