OWBI1::CIMName Class Reference

CIMName encapsulates a CIM Name, which is simply a string, with the special semantic of being case-insensitive and preserving. More...

#include <OWBI1_CIMName.hpp>

Inheritance diagram for OWBI1::CIMName:

Inheritance graph
[legend]
Collaboration diagram for OWBI1::CIMName:

Collaboration graph
[legend]
List of all members.

Public Types

typedef detail::CIMNameRepRef
CIMName::* 
safe_bool

Public Member Functions

 CIMName ()
 A default constructed CIMName is the empty string "".
 CIMName (const String &name)
 Create an CIMName object with the given name.
 CIMName (const char *name)
 Create an CIMName object with the given name.
 CIMName (const CIMName &other)
 CIMName (const detail::CIMNameRepRef &rep)
 ~CIMName ()
CIMNameoperator= (const String &name)
CIMNameoperator= (const char *name)
CIMNameoperator= (const CIMName &other)
String toString () const
 Get the String representation of the CIM Name.
const char * c_str () const
virtual void readObject (std::istream &istrm)
 Read the object from an input stream.
virtual void writeObject (std::ostream &ostrm) const
 Write the object to an output stream This function is equivalent to String::writeObject().
bool isValid () const
 Test if this is a valid CIMName.
 operator safe_bool () const
bool operator! () const
detail::CIMNameRepRef getRep () const

Private Attributes

detail::CIMNameRepRef m_rep

Friends

OWBI1_OWBI1PROVIFC_API bool operator< (const CIMName &x, const CIMName &y)
OWBI1_OWBI1PROVIFC_API bool operator== (const CIMName &x, const CIMName &y)

Detailed Description

CIMName encapsulates a CIM Name, which is simply a string, with the special semantic of being case-insensitive and preserving.

Definition at line 50 of file OWBI1_CIMName.hpp.


Member Typedef Documentation

typedef detail::CIMNameRepRef CIMName::* OWBI1::CIMName::safe_bool
 

Definition at line 108 of file OWBI1_CIMName.hpp.


Constructor & Destructor Documentation

OWBI1::CIMName::CIMName  ) 
 

A default constructed CIMName is the empty string "".

Definition at line 52 of file OWBI1_CIMName.cpp.

OWBI1::CIMName::CIMName const String name  ) 
 

Create an CIMName object with the given name.

This constructor is not explicit in order to facilitate conversions and comparisons

Parameters:
name The name for this CIMName specified as an String.

Definition at line 58 of file OWBI1_CIMName.cpp.

OWBI1::CIMName::CIMName const char *  name  ) 
 

Create an CIMName object with the given name.

This constructor is not explicit in order to facilitate conversions and comparisons

Parameters:
name The name for this CIMName specified as a NULL terminated string.

Definition at line 64 of file OWBI1_CIMName.cpp.

OWBI1::CIMName::CIMName const CIMName other  ) 
 

Definition at line 70 of file OWBI1_CIMName.cpp.

OWBI1::CIMName::CIMName const detail::CIMNameRepRef rep  )  [explicit]
 

OWBI1::CIMName::~CIMName  ) 
 

Definition at line 77 of file OWBI1_CIMName.cpp.


Member Function Documentation

const char * OWBI1::CIMName::c_str  )  const
 

Definition at line 114 of file OWBI1_CIMName.cpp.

References m_rep.

detail::CIMNameRepRef OWBI1::CIMName::getRep  )  const
 

Definition at line 154 of file OWBI1_CIMName.cpp.

References m_rep.

Referenced by OWBI1::CIMObjectPath::getKey(), OWBI1::CIMInstance::getProperty(), OWBI1::CIMProperty::setOriginClass(), and OWBI1::CIMProperty::setOverridingProperty().

bool OWBI1::CIMName::isValid  )  const
 

Test if this is a valid CIMName.

A valid CIMName is defined as != ""

Definition at line 134 of file OWBI1_CIMName.cpp.

References m_rep.

Referenced by operator safe_bool(), and operator!().

OWBI1::CIMName::operator CIMName::safe_bool  )  const
 

Definition at line 140 of file OWBI1_CIMName.cpp.

References isValid(), and m_rep.

bool OWBI1::CIMName::operator!  )  const
 

Definition at line 147 of file OWBI1_CIMName.cpp.

References isValid().

CIMName & OWBI1::CIMName::operator= const CIMName other  ) 
 

Definition at line 99 of file OWBI1_CIMName.cpp.

References m_rep.

CIMName & OWBI1::CIMName::operator= const char *  name  ) 
 

Definition at line 91 of file OWBI1_CIMName.cpp.

References m_rep.

CIMName & OWBI1::CIMName::operator= const String name  ) 
 

Definition at line 83 of file OWBI1_CIMName.cpp.

References OWBI1::String::c_str(), m_rep, and name.

void OWBI1::CIMName::readObject std::istream &  istrm  )  [virtual]
 

Read the object from an input stream.

This function is equivalent to String::readObject()

Parameters:
istrm The input stream to read from.

Implements OWBI1::SerializableIFC.

Definition at line 121 of file OWBI1_CIMName.cpp.

References m_rep.

String OWBI1::CIMName::toString  )  const
 

Get the String representation of the CIM Name.

Definition at line 107 of file OWBI1_CIMName.cpp.

References m_rep.

Referenced by OWBI1::CIMObjectPath::getKeyT(), and OWBI1::CIMInstance::getPropertyT().

void OWBI1::CIMName::writeObject std::ostream &  ostrm  )  const [virtual]
 

Write the object to an output stream This function is equivalent to String::writeObject().

Parameters:
ostrm The output stream to write to.

Implements OWBI1::SerializableIFC.

Definition at line 127 of file OWBI1_CIMName.cpp.

References m_rep.


Friends And Related Function Documentation

OWBI1_OWBI1PROVIFC_API bool operator< const CIMName x,
const CIMName y
[friend]
 

Definition at line 160 of file OWBI1_CIMName.cpp.

OWBI1_OWBI1PROVIFC_API bool operator== const CIMName x,
const CIMName y
[friend]
 

Definition at line 166 of file OWBI1_CIMName.cpp.


Member Data Documentation

detail::CIMNameRepRef OWBI1::CIMName::m_rep [private]
 

Definition at line 117 of file OWBI1_CIMName.hpp.

Referenced by c_str(), getRep(), isValid(), operator safe_bool(), OWBI1::operator<(), operator=(), OWBI1::operator==(), readObject(), toString(), and writeObject().


The documentation for this class was generated from the following files:
Generated on Thu Feb 9 09:18:08 2006 for openwbem by  doxygen 1.4.6