[an error occurred while processing this directive]
[an error occurred while processing this directive] [an error occurred while processing this directive]

Pegasus CIM Object Broker Documentation
[an error occurred while processing this directive]


[an error occurred while processing this directive]

 

Contents

o Introduction
o Objectives
o Overview
o Credits
o Pegasus Architecture
   o Design Goals
   o The Broker
   o Pegasus Providers.
   o Extension Services
   o Pegasus Clients.
   o Functional Flow
o Pegasus Components
   o Component Descriptions
   o Pegasus Directory Structure
o Pegasus Utilization
   o Pegasus Availability
   o Pegasus Installation
   o Pegasus Operation
   o Pegasus CIM Clients
   o Pegasus Providers
   o Pegasus MOF Compiler
o Programming Pegasus
   o CIM Objects in Pegasus
   o CIM Object Table
   o Class Definitions
o Pegasus Interfaces
   o CIM Operations over HTTP
   o Pegasus Client Interfaces
   o Pegasus Provider Interfaces
   o Pegasus Service Extension Interfaces
   o Repository Interfaces
o Writing Providers.
o Glossary
o Pegasus Code Examples
   o Client Examples
   o Client Coding Examples
   o Provider Coding Examples
o Document References
o Pegausus FAQ
o
In file ../../src/Pegasus/Common/CIMName.h:

class PEGASUS_COMMON_LINKAGE CIMName

The CIMName class represents the DMTF standard CIM name definition.

Documentation

The CIMName class represents the DMTF standard CIM name definition. The names of CIM classes, properties, qualifiers, and methods are all CIM names.

A CIM name must contain characters only from this set:

  • alphabetic (a-z and A-Z)
  • numeric (0-9)
  • underscore (_)
  • UCS-2 characters in the range 0x0080 to 0xFFEF
The first character of a CIM name may not be numeric. A CIMName may be null, meaning that it has no value.

Inheritance:

Public Methods

[more] CIMName ()
Constructs a null CIMName
[more] CIMName (const String& name)
Constructs a non-null CIMName with the specified name.
[more] CIMName (const char* name)
Constructs a non-null CIMName with the specified name.
[more]CIMName& operator= (const CIMName& name)
Assigns the value of the specified CIMName object to this object.
[more]CIMName& operator= (const String& name)
Sets the CIMName with a String name.
[more]const String& getString () const
Gets a String form of the CIM name.
[more]Boolean isNull () const
Determines whether the CIM name is null.
[more]void clear ()
Sets the CIM name to a null value.
[more]Boolean equal (const CIMName& name) const
Compares the CIMName with a specified CIMName.
[more]static Boolean legal (const String& name)
Determines whether a name is a valid CIM name.
[more]Boolean equal (const char* name) const
Compares the CIMName with a specified character string.
[more]CIMName& operator= (const char* name)
Sets the CIMName with a character string name.

o CIMName()
Constructs a null CIMName

o CIMName(const String& name)
Constructs a non-null CIMName with the specified name.
Throws:
InvalidNameException If the String does not contain a valid CIM name.
Parameters:
name - A String containing the CIM name.

o CIMName(const char* name)
Constructs a non-null CIMName with the specified name.
Throws:
InvalidNameException If the character string does not contain a valid CIM name.
All exceptions thrown by String(const char* str) can be thrown here
Parameters:
name - A character string containing the CIM name.

oCIMName& operator=(const CIMName& name)
Assigns the value of the specified CIMName object to this object.
Parameters:
name - The CIMName object from which to assign this CIMName object.

oCIMName& operator=(const String& name)
Sets the CIMName with a String name. The resulting CIMName object is non-null.

Example: 

        CIMName n;
        String type = "type";
        n = type;
Throws:
InvalidNameException If the String does not contain a valid CIM name.
Parameters:
name - A String containing the CIM name to set.
Returns:
A reference to this CIMName object.

oconst String& getString() const
Gets a String form of the CIM name.

Example: 

        CIMName n("name");
        String s = n.getString();
Returns:
A reference to a String containing the CIM name.

oBoolean isNull() const
Determines whether the CIM name is null.

Example: 

        CIMName n;
        assert(n.isNull());
        n = "name";
        assert(!n.isNull());
Returns:
True if the CIM name is null, false otherwise.

ovoid clear()
Sets the CIM name to a null value.

Example: 

        CIMName n("name");
        n.clear();
        assert(n.isNull());

oBoolean equal(const CIMName& name) const
Compares the CIMName with a specified CIMName. Comparisons of CIM names are case-insensitive.

Example: 

        CIMName n1("name");
        CIMName n2("Name");
        assert(n1.equal(n2));
Parameters:
name - The CIMName to be compared.
Returns:
True if this name is equivalent to the specified name, false otherwise.

ostatic Boolean legal(const String& name)
Determines whether a name is a valid CIM name.

Example: 

        assert(CIMName::legal("name"));
        assert(!CIMName::legal("3types"));
Parameters:
name - A String containing the name to test.
Returns:
True if the specified name is a valid CIM name, false otherwise.

oBoolean equal(const char* name) const
Compares the CIMName with a specified character string. Comparisons of CIM names are case-insensitive.
Parameters:
name - The name to be compared.
Returns:
True if this name is equivalent to the specified name, false otherwise.

oCIMName& operator=(const char* name)
Sets the CIMName with a character string name. The resulting CIMName object is non-null.
Throws:
InvalidNameException If the character string does not contain a valid CIM name.
All exceptions thrown by String(const char* str) can be thrown here
Parameters:
name - A character string containing the CIM name to set.
Returns:
A reference to this CIMName object.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java
[an error occurred while processing this directive]