OWBI1::CIMParameter Class Reference

The CIMParameter class encapsulates all data and functionality pertinent to a parameter to a method within a CIM class. More...

#include <OWBI1_CIMParameter.hpp>

Inheritance diagram for OWBI1::CIMParameter:

[legend]Collaboration diagram for OWBI1::CIMParameter:

[legend]List of all members.


Public Types
typedef COWIntrusiveReference< PARMData > CIMParameter::*	safe_bool
Public Member Functions
	CIMParameter ()
	Create a new CIMParameter object.
	CIMParameter (CIMNULL_t)
	Create a NULL CIMParameter object.
	CIMParameter (const CIMName &name)
	Create an CIMParameter object with a given name.
	CIMParameter (const char *name)
	Create an CIMParameter object with a given name.
	CIMParameter (const CIMParameter &arg)
	Copy constructor.
	~CIMParameter ()
	Destroy this CIMParameter object.
virtual void	setNull ()
	Set this to a null object.
CIMParameter &	operator= (const CIMParameter &arg)
	Assignment operator.
	operator safe_bool () const
bool	operator! () const
CIMParameter &	setQualifiers (const CIMQualifierArray &quals)
	Set the qualifiers for this parameter.
CIMQualifierArray	getQualifiers () const
	Get the qualifiers for this parameter.
CIMParameter &	setDataType (const CIMDataType &type)
	Set the data type for this parameter.
CIMDataType	getType () const
	Get the data type for this parameter.
Int32	getDataSize () const
CIMQualifier	getQualifier (const CIMName &name) const
	Get a qualifier by name for this parameter.
virtual CIMName	getName () const
virtual void	setName (const CIMName &name)
	Set the name of this CIMParameter.
virtual void	writeObject (std::ostream &ostrm) const
	Write this object to the given output stream.
virtual void	readObject (std::istream &istrm)
	Read this object from the given input stream.
virtual String	toString () const
virtual String	toMOF () const
bool	hasTrueQualifier (const CIMName &name) const
	Test if this property has a qualifier that is a boolean type with a value of true.
Private Attributes
COWIntrusiveReference< PARMData >	m_pdata
Friends
OWBI1_OWBI1PROVIFC_API bool	operator< (const CIMParameter &x, const CIMParameter &y)
Classes
struct	PARMData

Detailed Description

The CIMParameter class encapsulates all data and functionality pertinent to a parameter to a method within a CIM class.

Definition at line 52 of file OWBI1_CIMParameter.hpp.

Member Typedef Documentation

typedef COWIntrusiveReference<PARMData> CIMParameter::* OWBI1::CIMParameter::safe_bool

Definition at line 94 of file OWBI1_CIMParameter.hpp.

Constructor & Destructor Documentation

CIMParameter::CIMParameter ( )

Create a new CIMParameter object.

Definition at line 71 of file OWBI1_CIMParameter.cpp.

CIMParameter::CIMParameter ( CIMNULL_t ) [explicit]

Create a NULL CIMParameter object.

Definition at line 76 of file OWBI1_CIMParameter.cpp.

CIMParameter::CIMParameter ( const CIMName & name ) [explicit]

Create an CIMParameter object with a given name.

Parameters:

name The name for this parameter.

Definition at line 87 of file OWBI1_CIMParameter.cpp.
References m_pdata, and name.

CIMParameter::CIMParameter ( const char * name ) [explicit]

Create an CIMParameter object with a given name.

Parameters:

name The name for this parameter as a NULL terminated string.

Definition at line 81 of file OWBI1_CIMParameter.cpp.
References m_pdata.

CIMParameter::CIMParameter ( const CIMParameter & arg )

Copy constructor.

Parameters:

arg The CIMParameter object to make this one a copy of.

Definition at line 93 of file OWBI1_CIMParameter.cpp.

CIMParameter::~CIMParameter ( )

Destroy this CIMParameter object.

Definition at line 98 of file OWBI1_CIMParameter.cpp.

Member Function Documentation

Int32 CIMParameter::getDataSize ( ) const

Returns:
The size of the data for this parameter.

Definition at line 142 of file OWBI1_CIMParameter.cpp.

CIMName CIMParameter::getName ( ) const [virtual]

Returns:
The name of this CIMParameter.

Implements OWBI1::CIMElement.
Definition at line 162 of file OWBI1_CIMParameter.cpp.

CIMQualifier CIMParameter::getQualifier ( const CIMName & name ) const

Get a qualifier by name for this parameter.

Parameters:

name The name of the qualifier to retrieve.

Returns:
The CIMQualifier associated with the given name if there is one. Otherwise a NULL CIMQualifier.

Definition at line 148 of file OWBI1_CIMParameter.cpp.
References i, and name.

CIMQualifierArray CIMParameter::getQualifiers ( ) const

Get the qualifiers for this parameter.

Returns:
An CIMQualifierArray that contains the qualifiers for this parameter.

Definition at line 123 of file OWBI1_CIMParameter.cpp.

CIMDataType CIMParameter::getType ( ) const

Get the data type for this parameter.

Returns:
An CIMDataType for this parameter.

Definition at line 136 of file OWBI1_CIMParameter.cpp.

bool CIMParameter::hasTrueQualifier ( const CIMName & name ) const

Test if this property has a qualifier that is a boolean type with a value of true.

Parameters:

name The name of the qualifier to test.

Returns:
true if the qualifier exists and has a value of true.

Definition at line 247 of file OWBI1_CIMParameter.cpp.
References BOOLEAN, OWBI1::CIMValue::getType(), OWBI1::CIMQualifier::getValue(), and name.

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

Returns:
true if this a valid CIMParameter object.

Definition at line 98 of file OWBI1_CIMParameter.hpp.
References m_pdata.

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

Definition at line 100 of file OWBI1_CIMParameter.hpp.

CIMParameter & CIMParameter::operator= ( const CIMParameter & arg )

Assignment operator.

Parameters:

arg The CIMParameter object to assign to this one.

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

Definition at line 109 of file OWBI1_CIMParameter.cpp.
References m_pdata.

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

Read this object from the given input stream.

Parameters:

istrm The input stream to read this CIMElement from.

Implements OWBI1::SerializableIFC.

CIMParameter & CIMParameter::setDataType ( const CIMDataType & type )

Set the data type for this parameter.

Parameters:

type The CIMDataType for this parameter.

Returns:
a reference to *this

Definition at line 129 of file OWBI1_CIMParameter.cpp.
References type.

void CIMParameter::setName ( const CIMName & name ) [virtual]

Set the name of this CIMParameter.

Parameters:

name The new name for this CIMParameter.

Implements OWBI1::CIMElement.
Definition at line 168 of file OWBI1_CIMParameter.cpp.
References name.

void CIMParameter::setNull ( ) [virtual]

Set this to a null object.

Implements OWBI1::CIMBase.
Definition at line 103 of file OWBI1_CIMParameter.cpp.

CIMParameter & CIMParameter::setQualifiers ( const CIMQualifierArray & quals )

Set the qualifiers for this parameter.

Parameters:

quals An CIMQualifierArray that contains the qualifiers for this parameter.

Returns:
a reference to *this

Definition at line 116 of file OWBI1_CIMParameter.cpp.

String CIMParameter::toMOF ( ) const [virtual]

Returns:
An String that contains the MOF representation of this CIMParameter object.

Implements OWBI1::CIMBase.
Definition at line 208 of file OWBI1_CIMParameter.cpp.
References i.

String CIMParameter::toString ( ) const [virtual]

Returns:
a string representation of this CIMParameter.

Implements OWBI1::CIMElement.
Definition at line 202 of file OWBI1_CIMParameter.cpp.
References OWBI1::String::toString().

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

Write this object to the given output stream.

Parameters:

ostrm The output stream to write this CIMElement to.

Implements OWBI1::SerializableIFC.

Friends And Related Function Documentation

OWBI1_OWBI1PROVIFC_API bool operator< ( const CIMParameter & x,

const CIMParameter & y

) [friend]

Definition at line 241 of file OWBI1_CIMParameter.cpp.

Member Data Documentation

COWIntrusiveReference<PARMData> OWBI1::CIMParameter::m_pdata [private]

Definition at line 180 of file OWBI1_CIMParameter.hpp.
Referenced by CIMParameter(), operator safe_bool(), OWBI1::operator<(), and operator=().

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

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

1.4.6

OWBI1::CIMParameter Class Reference

Public Types

Public Member Functions

Private Attributes