OW_NAMESPACE::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 <OW_CIMName.hpp>

Inheritance diagram for OW_NAMESPACE::CIMName:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef String 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 ()
CIMNameoperator= (const String &name)
CIMNameoperator= (const char *name)
String toString () const
 Get the String representation of the CIM Name.
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

Private Attributes

String m_name

Friends

OW_COMMON_API bool operator< (const CIMName &x, const CIMName &y)
OW_COMMON_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 OW_CIMName.hpp.


Member Typedef Documentation

typedef String CIMName::* OW_NAMESPACE::CIMName::safe_bool
 

Definition at line 103 of file OW_CIMName.hpp.


Constructor & Destructor Documentation

OW_NAMESPACE::CIMName::CIMName  ) 
 

A default constructed CIMName is the empty string "".

Definition at line 48 of file OW_CIMName.cpp.

OW_NAMESPACE::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 53 of file OW_CIMName.cpp.

OW_NAMESPACE::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 59 of file OW_CIMName.cpp.

OW_NAMESPACE::CIMName::~CIMName  ) 
 

Definition at line 65 of file OW_CIMName.cpp.


Member Function Documentation

bool OW_NAMESPACE::CIMName::isValid  )  const
 

Test if this is a valid CIMName.

A valid CIMName is defined as != ""

Definition at line 107 of file OW_CIMName.cpp.

References OW_NAMESPACE::String::empty(), and m_name.

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

OW_NAMESPACE::CIMName::operator CIMName::safe_bool  )  const
 

Definition at line 113 of file OW_CIMName.cpp.

References isValid(), and m_name.

bool OW_NAMESPACE::CIMName::operator!  )  const
 

Definition at line 120 of file OW_CIMName.cpp.

References isValid().

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

Definition at line 79 of file OW_CIMName.cpp.

References m_name.

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

Definition at line 71 of file OW_CIMName.cpp.

References m_name, and name.

void OW_NAMESPACE::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 OW_NAMESPACE::SerializableIFC.

Definition at line 94 of file OW_CIMName.cpp.

References m_name, and OW_NAMESPACE::String::readObject().

String OW_NAMESPACE::CIMName::toString  )  const
 

Get the String representation of the CIM Name.

Definition at line 87 of file OW_CIMName.cpp.

References m_name.

Referenced by OW_NAMESPACE::CIMServer::_commonAssociators(), OW_NAMESPACE::CIMServer::_getAssociationClasses(), OW_NAMESPACE::CIMRepository::_getAssociationClasses(), OW_NAMESPACE::CIMServer::_getCIMInstanceNames(), OW_NAMESPACE::CIMServer::_getCIMInstances(), OW_NAMESPACE::MetaRepository::_getClassNameNodes(), OW_NAMESPACE::CIMServer::_instGetClass(), OW_NAMESPACE::MetaRepository::_makeClassPath(), OW_NAMESPACE::MetaRepository::_makeQualPath(), OW_NAMESPACE::IndicationServerImplThread::_processIndication(), OW_NAMESPACE::MetaRepository::adjustClass(), OW_NAMESPACE::WQLProcessor::classIsDerivedFrom(), OW_NAMESPACE::WQLInstancePropertySource::classIsDerivedFrom(), OW_NAMESPACE::CIMServer::createInstance(), OW_NAMESPACE::MetaRepository::enumClass(), OW_NAMESPACE::MetaRepository::enumClassNames(), OW_NAMESPACE::WQLFilterRep::enumInstances(), OW_NAMESPACE::ProviderManager::findIndicationProviders(), OW_NAMESPACE::getClassChildren(), OW_NAMESPACE::ProviderManager::getIndicationProviders(), OW_NAMESPACE::CIMServer::getInstance(), OW_NAMESPACE::CIMObjectPath::getKeyT(), OW_NAMESPACE::ProviderManager::getMethodProvider(), OW_NAMESPACE::CIMInstance::getPropertyT(), OW_NAMESPACE::ProviderManager::getSecondaryInstanceProviders(), OW_NAMESPACE::LifecycleIndicationPoller::poll(), and OW_NAMESPACE::UtilKeyArray::toString().

void OW_NAMESPACE::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 OW_NAMESPACE::SerializableIFC.

Definition at line 100 of file OW_CIMName.cpp.

References m_name, and OW_NAMESPACE::String::writeObject().


Friends And Related Function Documentation

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

Definition at line 126 of file OW_CIMName.cpp.

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

Definition at line 132 of file OW_CIMName.cpp.


Member Data Documentation

String OW_NAMESPACE::CIMName::m_name [private]
 

Definition at line 111 of file OW_CIMName.hpp.

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


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