OW_NAMESPACE::CIMFlavor Class Reference

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

#include <OW_CIMFlavor.hpp>

Inheritance diagram for OW_NAMESPACE::CIMFlavor:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef Int32 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 CIMFlavor &arg)
 Copy constructor.
 operator safe_bool () const
bool operator! () const
virtual void setNull ()
 Set this to a null object.
CIMFlavoroperator= (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

Static Public Member Functions

static bool validFlavor (Int32 iflavor)
 Determine if an integral value represents a valid flavor.

Static Private Member Functions

static bool validScope (Int32 iflavor)

Private Attributes

Int32 m_flavor
 The integral representation of this flavor.

Friends

bool operator< (const CIMFlavor &x, const CIMFlavor &y)

Detailed Description

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

Definition at line 50 of file OW_CIMFlavor.hpp.


Member Typedef Documentation

typedef Int32 CIMFlavor::* OW_NAMESPACE::CIMFlavor::safe_bool
 

Definition at line 113 of file OW_CIMFlavor.hpp.


Member Enumeration Documentation

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


Constructor & Destructor Documentation

OW_NAMESPACE::CIMFlavor::CIMFlavor Flavor  iflavor  )  [inline]
 

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 91 of file OW_CIMFlavor.hpp.

OW_NAMESPACE::CIMFlavor::CIMFlavor  )  [inline]
 

Default constructor - Creates an invalid CIMFlavor.

Definition at line 102 of file OW_CIMFlavor.hpp.

OW_NAMESPACE::CIMFlavor::CIMFlavor const CIMFlavor arg  )  [inline]
 

Copy constructor.

Parameters:
arg The CIMFlavor to create a copy of.

Definition at line 108 of file OW_CIMFlavor.hpp.


Member Function Documentation

bool OW_NAMESPACE::CIMFlavor::equals const CIMFlavor arg  )  [inline]
 

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 150 of file OW_CIMFlavor.hpp.

References m_flavor.

Int32 OW_NAMESPACE::CIMFlavor::getFlavor  )  const [inline]
 

Returns:
the integral value of this CIMFlavor object.

Definition at line 196 of file OW_CIMFlavor.hpp.

Referenced by OW_NAMESPACE::CIMQualifierType::addFlavor(), OW_NAMESPACE::CIMQualifier::addFlavor(), OW_NAMESPACE::CIMtoXML(), OW_NAMESPACE::CIMQualifierType::hasFlavor(), and OW_NAMESPACE::CIMQualifier::hasFlavor().

bool OW_NAMESPACE::CIMFlavor::isValid  )  [inline]
 

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

Definition at line 139 of file OW_CIMFlavor.hpp.

OW_NAMESPACE::CIMFlavor::operator safe_bool  )  const [inline]
 

Returns:
true if this is a valid flavor

Definition at line 117 of file OW_CIMFlavor.hpp.

References m_flavor.

bool OW_NAMESPACE::CIMFlavor::operator!  )  const [inline]
 

Definition at line 119 of file OW_CIMFlavor.hpp.

bool OW_NAMESPACE::CIMFlavor::operator!= const CIMFlavor arg  )  [inline]
 

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 170 of file OW_CIMFlavor.hpp.

CIMFlavor& OW_NAMESPACE::CIMFlavor::operator= const CIMFlavor arg  )  [inline]
 

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 131 of file OW_CIMFlavor.hpp.

References m_flavor.

bool OW_NAMESPACE::CIMFlavor::operator== const CIMFlavor arg  )  [inline]
 

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 160 of file OW_CIMFlavor.hpp.

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

void OW_NAMESPACE::CIMFlavor::setNull  )  [virtual]
 

Set this to a null object.

Implements OW_NAMESPACE::CIMBase.

Definition at line 105 of file OW_CIMFlavor.cpp.

References INVALID, and m_flavor.

String OW_NAMESPACE::CIMFlavor::toMOF  )  const [virtual]
 

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

Implements OW_NAMESPACE::CIMBase.

Definition at line 62 of file OW_CIMFlavor.cpp.

References DISABLEOVERRIDE, ENABLEOVERRIDE, m_flavor, RESTRICTED, TOSUBCLASS, and TRANSLATE.

Referenced by toString().

String OW_NAMESPACE::CIMFlavor::toString  )  const [virtual]
 

Returns:
An String object that represents this CIMFlavor.

Implements OW_NAMESPACE::CIMBase.

Definition at line 54 of file OW_CIMFlavor.cpp.

References s, and toMOF().

static bool OW_NAMESPACE::CIMFlavor::validFlavor Int32  iflavor  )  [inline, 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 76 of file OW_CIMFlavor.hpp.

static bool OW_NAMESPACE::CIMFlavor::validScope Int32  iflavor  )  [inline, static, private]
 

Definition at line 198 of file OW_CIMFlavor.hpp.

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


Friends And Related Function Documentation

bool operator< const CIMFlavor x,
const CIMFlavor y
[friend]
 

Definition at line 207 of file OW_CIMFlavor.hpp.


Member Data Documentation

Int32 OW_NAMESPACE::CIMFlavor::m_flavor [private]
 

The integral representation of this flavor.

Definition at line 206 of file OW_CIMFlavor.hpp.

Referenced by equals(), operator safe_bool(), operator=(), setNull(), and toMOF().


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