OWBI1::CIMNameSpace Class Reference

The CIMNameSpace class represents a CIM namespace. More...

#include <OWBI1_CIMNameSpace.hpp>

Inheritance diagram for OWBI1::CIMNameSpace:

[legend]Collaboration diagram for OWBI1::CIMNameSpace:


Public Types
typedef COWIntrusiveReference< NSData > CIMNameSpace::*	safe_bool
Public Member Functions
	CIMNameSpace ()
	Create a new CIMNameSpace object.
	CIMNameSpace (CIMNULL_t)
	Create a NULL CIMNameSpace object.
	CIMNameSpace (const CIMUrl &hostUrl, const String &nameSpace)
	Create a new CIMNameSpace object.
	CIMNameSpace (const String &nameSpace)
	Create a new CIMNameSpace object.
	CIMNameSpace (const char *nameSpace)
	Create a new CIMNameSpace object.
	CIMNameSpace (const CIMNameSpace &arg)
	Create a new CIMNameSpace object that is a copy of another.
	~CIMNameSpace ()
	Destroy this CIMNameSpace object.
virtual void	setNull ()
	Set this to a null object.
CIMNameSpace &	operator= (const CIMNameSpace &arg)
	Assignment operator.
	operator safe_bool () const
bool	operator! () const
String	getNameSpace () const
String	getHost () const
CIMUrl	getHostUrl () const
Int32	getPortNumber () const
String	getProtocol () const
String	getFileName () const
bool	isLocal () const
CIMNameSpace &	setNameSpace (const String &nameSpace)
	Set the namespace component of this CIMNameSpace object.
CIMNameSpace &	setHostUrl (const CIMUrl &hostUrl)
	Set the host url component of this CIMNameSpace object.
CIMNameSpace &	setHost (const String &host)
	Set the host of the url component for this CIMNameSpace object.
CIMNameSpace &	setProtocol (const String &protocol)
	Set the protocol.
virtual void	readObject (std::istream &istrm)
	Read this object from an input stream.
virtual void	writeObject (std::ostream &ostrm) const
	Write this object to an output stream.
virtual String	toString () const
virtual String	toMOF () const
Private Attributes
COWIntrusiveReference< NSData >	m_pdata
Friends
bool	operator< (const CIMNameSpace::NSData &x, const CIMNameSpace::NSData &y)
OWBI1_OWBI1PROVIFC_API bool	operator< (const CIMNameSpace &lhs, const CIMNameSpace &rhs)
Classes
struct	NSData

Detailed Description

The CIMNameSpace class represents a CIM namespace.

The CIM namespace is a component of a CIM object name (namespace + model path) that provides a scope within which all objects are unique. CIMNameSpace objects are ref counted and copy on write. It is possible to have a NULL CIMNameSpace object.

Definition at line 55 of file OWBI1_CIMNameSpace.hpp.

Member Typedef Documentation

typedef COWIntrusiveReference<NSData> CIMNameSpace::* OWBI1::CIMNameSpace::safe_bool

Definition at line 112 of file OWBI1_CIMNameSpace.hpp.

Constructor & Destructor Documentation

OWBI1::CIMNameSpace::CIMNameSpace ( )

Create a new CIMNameSpace object.

Definition at line 64 of file OWBI1_CIMNameSpace.cpp.

OWBI1::CIMNameSpace::CIMNameSpace ( CIMNULL_t ) [explicit]

Create a NULL CIMNameSpace object.

Definition at line 70 of file OWBI1_CIMNameSpace.cpp.

OWBI1::CIMNameSpace::CIMNameSpace ( const CIMUrl & hostUrl,

const String & nameSpace

)

Create a new CIMNameSpace object.

Parameters:

hostUrl The url component of this CIMNameSpace object.

nameSpace The namespace (e.g. "root/cimv2") component of this CIMNameSpace object.

Definition at line 75 of file OWBI1_CIMNameSpace.cpp.
References OWBI1::String::empty(), m_pdata, and setNameSpace().

OWBI1::CIMNameSpace::CIMNameSpace ( const String & nameSpace ) [explicit]

Create a new CIMNameSpace object.

Parameters:

hostUrl The url component of this CIMNameSpace object.

nameSpace The namespace (e.g. "root/cimv2") component of this CIMNameSpace object.

Definition at line 90 of file OWBI1_CIMNameSpace.cpp.
References OWBI1::String::empty(), and setNameSpace().

OWBI1::CIMNameSpace::CIMNameSpace ( const char * nameSpace ) [explicit]

Create a new CIMNameSpace object.

Parameters:

hostUrl The url component of this CIMNameSpace object.

nameSpace The namespace (e.g. "root/cimv2") component of this CIMNameSpace object.

Definition at line 103 of file OWBI1_CIMNameSpace.cpp.
References setNameSpace().

OWBI1::CIMNameSpace::CIMNameSpace ( const CIMNameSpace & arg )

Create a new CIMNameSpace object that is a copy of another.

Parameters:

arg The CIMNameSpace to make this object a copy of.

Definition at line 116 of file OWBI1_CIMNameSpace.cpp.

OWBI1::CIMNameSpace::~CIMNameSpace ( )

Destroy this CIMNameSpace object.

Definition at line 121 of file OWBI1_CIMNameSpace.cpp.

Member Function Documentation

String OWBI1::CIMNameSpace::getFileName ( ) const

Returns:
The file name from the URL component of this CIMNameSpace.

Definition at line 169 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

String OWBI1::CIMNameSpace::getHost ( ) const

Returns:
The host component of this CIMNameSpace object.

Definition at line 145 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

CIMUrl OWBI1::CIMNameSpace::getHostUrl ( ) const

Returns:
The host URL component of this CIMNameSpace object.

Definition at line 151 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

String OWBI1::CIMNameSpace::getNameSpace ( ) const

Returns:
The namespace component of this CIMNameSpace object.

Definition at line 139 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

Int32 OWBI1::CIMNameSpace::getPortNumber ( ) const

Returns:
The port number from the URL component of this CIMNameSpace.

Definition at line 157 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

String OWBI1::CIMNameSpace::getProtocol ( ) const

Returns:
The protocol from the URL component of this CIMNameSpace.

Definition at line 163 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

bool OWBI1::CIMNameSpace::isLocal ( ) const

Returns:
true if this namespace refers to a namespace hosted by the local CIMOM.

Definition at line 175 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

OWBI1::CIMNameSpace::operator safe_bool ( ) const [inline]

Definition at line 113 of file OWBI1_CIMNameSpace.hpp.
References m_pdata.

bool OWBI1::CIMNameSpace::operator! ( ) const [inline]

Definition at line 115 of file OWBI1_CIMNameSpace.hpp.

CIMNameSpace & OWBI1::CIMNameSpace::operator= ( const CIMNameSpace & arg )

Assignment operator.

Parameters:

arg The CIMNameSpace object to assign to this one.

Returns:
A reference to this object after the assignment has been made.

Definition at line 132 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

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

Read this object from an input stream.

Parameters:

istrm The input stream to read this object from.

Implements OWBI1::SerializableIFC.

CIMNameSpace & OWBI1::CIMNameSpace::setHost ( const String & host )

Set the host of the url component for this CIMNameSpace object.

Parameters:

host The new host for the url component of this object.

Returns:
a reference to *this

Definition at line 209 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

CIMNameSpace & OWBI1::CIMNameSpace::setHostUrl ( const CIMUrl & hostUrl )

Set the host url component of this CIMNameSpace object.

Parameters:

hostUrl The new host url for this CIMNameSpace.

Returns:
a reference to *this

Definition at line 202 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

CIMNameSpace & OWBI1::CIMNameSpace::setNameSpace ( const String & nameSpace )

Set the namespace component of this CIMNameSpace object.

Parameters:

nameSpace The namespace for this object as an String

Returns:
a reference to *this

Definition at line 187 of file OWBI1_CIMNameSpace.cpp.
References OWBI1::String::c_str(), m_pdata, and OWBI1::String::trim().
Referenced by CIMNameSpace().

void OWBI1::CIMNameSpace::setNull ( ) [virtual]

Set this to a null object.

Implements OWBI1::CIMBase.
Definition at line 126 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

CIMNameSpace & OWBI1::CIMNameSpace::setProtocol ( const String & protocol )

Set the protocol.

Parameters:

protocol The protocol component of the url for the name space

Returns:
a reference to *this

Definition at line 216 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

String OWBI1::CIMNameSpace::toMOF ( ) const [virtual]

Returns:
The MOF representation of this CIMNameSpace object. Currently unimplemented.

Implements OWBI1::CIMBase.
Definition at line 254 of file OWBI1_CIMNameSpace.cpp.

String OWBI1::CIMNameSpace::toString ( ) const [virtual]

Returns:
The string representation of this CIMNameSpace object.

Implements OWBI1::CIMBase.
Definition at line 181 of file OWBI1_CIMNameSpace.cpp.
References m_pdata.

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

Write this object to an output stream.

Parameters:

ostrm The output stream to write this object to.

Implements OWBI1::SerializableIFC.

Friends And Related Function Documentation

OWBI1_OWBI1PROVIFC_API bool operator< ( const CIMNameSpace & lhs,

const CIMNameSpace & rhs

) [friend]

Definition at line 247 of file OWBI1_CIMNameSpace.cpp.

bool operator< ( const CIMNameSpace::NSData & x,

const CIMNameSpace::NSData & y

) [friend]

Definition at line 57 of file OWBI1_CIMNameSpace.cpp.

Member Data Documentation

COWIntrusiveReference<NSData> OWBI1::CIMNameSpace::m_pdata [private]

Definition at line 196 of file OWBI1_CIMNameSpace.hpp.
Referenced by CIMNameSpace(), getFileName(), getHost(), getHostUrl(), getNameSpace(), getPortNumber(), getProtocol(), isLocal(), operator safe_bool(), OWBI1::operator<(), operator=(), setHost(), setHostUrl(), setNameSpace(), setNull(), setProtocol(), and toString().

The documentation for this class was generated from the following files:

Generated on Thu Feb 9 09:18:09 2006 for openwbem by

1.4.6

OWBI1::CIMNameSpace Class Reference

Public Types

Public Member Functions

Private Attributes