OWBI1::CIMFlavor Class Reference

The CIMFlavor class represents the flavor that is associated with a CIMQualifier. More...

#include <OWBI1_CIMFlavor.hpp>

Inheritance diagram for OWBI1::CIMFlavor:

[legend]Collaboration diagram for OWBI1::CIMFlavor:


Public Types
typedef detail::CIMFlavorRepRef CIMFlavor::*	safe_bool
enum	Flavor { INVALID = 0, ENABLEOVERRIDE = 1, DISABLEOVERRIDE = 2, RESTRICTED = 3, TOSUBCLASS = 4, TRANSLATE = 5, LASTVALUE = 6 }
Public Member Functions
	CIMFlavor (Flavor iflavor)
	Create a new CIMFlavor object.
	CIMFlavor ()
	Default constructor - Creates an invalid CIMFlavor.
	CIMFlavor (const detail::CIMFlavorRepRef &rep)
	CIMFlavor (const CIMFlavor &arg)
	Copy constructor.
	operator safe_bool () const
bool	operator! () const
virtual void	setNull ()
	Set this to a null object.
CIMFlavor &	operator= (const CIMFlavor &arg)
	Assign the values from a given CIMFlavor object to this one.
bool	isValid ()
bool	equals (const CIMFlavor &arg)
	Check if another CIMFlavor object is equal to this one.
bool	operator== (const CIMFlavor &arg)
	Equality operator.
bool	operator!= (const CIMFlavor &arg)
	Inequality operator.
virtual void	readObject (std::istream &istrm)
	Read this CIMFlavor object from an input stream.
virtual void	writeObject (std::ostream &ostrm) const
	Write this CIMFlavor object to an output stream.
virtual String	toString () const
virtual String	toMOF () const
Int32	getFlavor () const
detail::CIMFlavorRepRef	getRep () const
Static Public Member Functions
static bool	validFlavor (Int32 iflavor)
	Determine if an integral value represents a valid flavor.
Private Attributes
detail::CIMFlavorRepRef	m_rep

Detailed Description

The CIMFlavor class represents the flavor that is associated with a CIMQualifier.

Definition at line 50 of file OWBI1_CIMFlavor.hpp.

Member Typedef Documentation

typedef detail::CIMFlavorRepRef CIMFlavor::* OWBI1::CIMFlavor::safe_bool

Definition at line 102 of file OWBI1_CIMFlavor.hpp.

Member Enumeration Documentation

enum OWBI1::CIMFlavor::Flavor

Enumerator:

INVALID Invalid flavor.

ENABLEOVERRIDE Overridable.

DISABLEOVERRIDE Cannot be overriden.

RESTRICTED Applies only to the declaring class.

TOSUBCLASS Qualifier is inherited.

TRANSLATE Qualifier can be specified in multiple locales.

LASTVALUE

Definition at line 53 of file OWBI1_CIMFlavor.hpp.

Constructor & Destructor Documentation

OWBI1::CIMFlavor::CIMFlavor ( Flavor iflavor )

Create a new CIMFlavor object.

Parameters:

iflavor The flavor value for this CIMFlavor object. Cabe be one of the following values: CIMFlavor::ENABLEOVERRIDE = overridable CIMFlavor::DISABLEOVERRIDE = cannot be overriden CIMFlavor::RESTRICTED = applies only to the declaring class CIMFlavor::TOSUBCLASS = qualifier is inherited CIMFlavor::TRANSLATE = qualifier can be specified in multiple locales

Definition at line 101 of file OWBI1_CIMFlavor.cpp.

OWBI1::CIMFlavor::CIMFlavor ( )

Default constructor - Creates an invalid CIMFlavor.

Definition at line 107 of file OWBI1_CIMFlavor.cpp.

OWBI1::CIMFlavor::CIMFlavor ( const detail::CIMFlavorRepRef & rep ) [explicit]

Definition at line 120 of file OWBI1_CIMFlavor.cpp.

OWBI1::CIMFlavor::CIMFlavor ( const CIMFlavor & arg )

Copy constructor.

Parameters:

arg The CIMFlavor to create a copy of.

Definition at line 113 of file OWBI1_CIMFlavor.cpp.

Member Function Documentation

bool OWBI1::CIMFlavor::equals ( const CIMFlavor & arg )

Check if another CIMFlavor object is equal to this one.

Parameters:

arg The CIMFlavor to compare this object to.

Returns:
true if the given CIMFlavor object has the same flavor value as this one.

Definition at line 141 of file OWBI1_CIMFlavor.cpp.
References m_rep.
Referenced by operator!=(), and operator==().

Int32 OWBI1::CIMFlavor::getFlavor ( ) const

Returns:
the integral value of this CIMFlavor object.

Definition at line 159 of file OWBI1_CIMFlavor.cpp.
References m_rep.

detail::CIMFlavorRepRef OWBI1::CIMFlavor::getRep ( ) const

Definition at line 180 of file OWBI1_CIMFlavor.cpp.
References m_rep.
Referenced by OWBI1::CIMQualifierType::addFlavor(), OWBI1::CIMQualifier::addFlavor(), OWBI1::CIMQualifierType::hasFlavor(), OWBI1::CIMQualifier::hasFlavor(), and OWBI1::operator<().

bool OWBI1::CIMFlavor::isValid ( )

Returns:
true if this CIMFlavor is valid. Otherwise false.

Definition at line 134 of file OWBI1_CIMFlavor.cpp.
References m_rep.

OWBI1::CIMFlavor::operator safe_bool ( ) const

Returns:
true if this is a valid flavor

Definition at line 88 of file OWBI1_CIMFlavor.cpp.
References m_rep.

bool OWBI1::CIMFlavor::operator! ( ) const

Definition at line 95 of file OWBI1_CIMFlavor.cpp.
References m_rep.

bool OWBI1::CIMFlavor::operator!= ( const CIMFlavor & arg )

Inequality operator.

Parameters:

arg The CIMFlavor to compare this object to.

Returns:
true if the given CIMFlavor object has a different flavor value than this one.

Definition at line 153 of file OWBI1_CIMFlavor.cpp.
References equals().

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

Assign the values from a given CIMFlavor object to this one.

Parameters:

arg The CIMFlavor object to assign values from.

Returns:
A reference to this CIMFlavor object after the assignment is made.

Definition at line 127 of file OWBI1_CIMFlavor.cpp.
References m_rep.

bool OWBI1::CIMFlavor::operator== ( const CIMFlavor & arg )

Equality operator.

Parameters:

arg The CIMFlavor to compare this object to.

Returns:
true if the given CIMFlavor object has the same flavor value as this one.

Definition at line 147 of file OWBI1_CIMFlavor.cpp.
References equals().

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

Read this CIMFlavor object from an input stream.

Parameters:

istrm The input stream to read this flavor from.

Implements OWBI1::SerializableIFC.

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

Set this to a null object.

Implements OWBI1::CIMBase.
Definition at line 82 of file OWBI1_CIMFlavor.cpp.
References m_rep.

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

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

Implements OWBI1::CIMBase.
Definition at line 62 of file OWBI1_CIMFlavor.cpp.
References m_rep.

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

Returns:
An String object that represents this CIMFlavor.

Implements OWBI1::CIMBase.
Definition at line 56 of file OWBI1_CIMFlavor.cpp.
References m_rep.

bool OWBI1::CIMFlavor::validFlavor ( Int32 iflavor ) [static]

Determine if an integral value represents a valid flavor.

Parameters:

iflavor The integral value verify.

Returns:
true if the given integral value is a valid flavor. Otherwise false.

Definition at line 173 of file OWBI1_CIMFlavor.cpp.

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

Write this CIMFlavor object to an output stream.

Parameters:

ostrm The output stream to write this object to.

Implements OWBI1::SerializableIFC.

Member Data Documentation

detail::CIMFlavorRepRef OWBI1::CIMFlavor::m_rep [private]

Definition at line 172 of file OWBI1_CIMFlavor.hpp.
Referenced by equals(), getFlavor(), getRep(), isValid(), operator safe_bool(), operator!(), operator=(), setNull(), toMOF(), and toString().

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

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

1.4.6

OWBI1::CIMFlavor Class Reference

Public Types

Public Member Functions