CIMName Class Reference
#include <CIMName.h>
Public Member Functions
CIMName () CIMName (const String &name) CIMName (const char *name) CIMName & operator= (const CIMName &name) CIMName & operator= (const String &name) const String & getString () const Boolean isNull () const void clear () Boolean equal (const CIMName &name) const Static Public Member Functions
static Boolean legal (const String &name) Detailed Description
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.
Constructor & Destructor Documentation
CIMName::CIMName ( ) Constructs a null CIMName.
CIMName::CIMName ( const String & name ) Constructs a non-null CIMName with the specified name.
- Parameters:
name A String containing the CIM name.
- Exceptions:
InvalidNameException If the String does not contain a valid CIM name.
CIMName::CIMName ( const char * name ) Constructs a non-null CIMName with the specified name.
- Parameters:
name A character string containing the CIM name.
- Exceptions:
InvalidNameException If the character string does not contain a valid CIM name. All exceptions thrown by String(const char* str) can be thrown here Member Function Documentation
void CIMName::clear ( )
Boolean CIMName::equal ( const CIMName & name ) const
const String& CIMName::getString ( ) const
Boolean CIMName::isNull ( ) const
static Boolean CIMName::legal ( const String & name ) [static]
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.
Sets the CIMName with a String name. The resulting CIMName object is non-null.
Example:
CIMName n; String type = "type"; n = type;
- Parameters:
name A String containing the CIM name to set.
- Returns:
- A reference to this CIMName object.
- Exceptions:
InvalidNameException If the String does not contain a valid CIM name.
The documentation for this class was generated from the following file:
- /srv/build/STABLE_8/pkgs/tog-pegasus/BUILD/pegasus/src/Pegasus/Common/CIMName.h