OW_NAMESPACE::CIMProperty Class Reference

The CIMProperty class encapsulates all data and functionality petinent to a CIM property found in a CIM class or a CIM Instance. More...

#include <OW_CIMProperty.hpp>

Inheritance diagram for OW_NAMESPACE::CIMProperty:

[legend]Collaboration diagram for OW_NAMESPACE::CIMProperty:

[legend]List of all members.

Public Types
typedef COWIntrusiveReference< PROPData > CIMProperty::*	safe_bool
Public Member Functions
	CIMProperty ()
	Create a new CIMProperty object.
	CIMProperty (CIMNULL_t)
	Create a NULL CIMProperty object.
	CIMProperty (const CIMName &name)
	Create an CIMProperty object with a given name.
	CIMProperty (const char *name)
	Create an CIMProperty object with a given name.
	CIMProperty (const CIMName &name, const CIMValue &value)
	Create an CIMProperty object with a name and a value.
	CIMProperty (const CIMName &name, const CIMDataType &dt)
	Create an CIMProperty object with a name and a type.
	CIMProperty (const CIMProperty &arg)
	Copy constructor.
	~CIMProperty ()
	Destroy this CIMProperty object.
virtual void	setNull ()
	Set this to a null object.
CIMProperty &	operator= (const CIMProperty &arg)
	Assignment operator.
	operator safe_bool () const
bool	operator! () const
CIMProperty	clone () const
CIMProperty	clone (WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin) const
	Create a copy of this CIMProperty object base on filtering criteria.
CIMQualifierArray	getQualifiers () const
	Get the qualifiers for this property.
CIMProperty &	setQualifiers (const CIMQualifierArray &quals)
	Set the qualifiers for this property object.
String	getOriginClass () const
	Get the origin class for this property.
CIMProperty &	setOriginClass (const CIMName &originCls)
	Set the origin class for this property.
CIMProperty &	setValue (const CIMValue &val)
	Set the value of this property.
CIMValue	getValue () const
CIMValue	getValueT () const
CIMProperty &	setDataType (const CIMDataType &type)
	Set the data type for this property.
CIMProperty &	setDataType (const CIMDataType::Type &type)
	Set the data type for this property.
CIMDataType	getDataType () const
Int32	getSize () const
CIMProperty &	setDataSize (Int32 size)
	Set the size of the data for this property.
CIMProperty &	setOverridingProperty (const CIMName &opname)
	Set the overriding property name.
String	getOverridingProperty () const
bool	isReference () const
CIMQualifier	getQualifier (const CIMName &name) const
	Get the qualifier associated with the given name from this property.
CIMQualifier	getQualifierT (const CIMName &name) const
	Get the qualifier associated with the given name from this property.
CIMProperty &	setQualifier (const CIMQualifier &qual)
	Set the value of a qaulifier on this property.
CIMProperty &	addQualifier (const CIMQualifier &qual)
	Add a qualifier to this property.
bool	removeQualifier (const CIMName &name)
	Remove a qualifier from this property.
bool	isKey () const
CIMProperty	filter (WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers) const
	Create a filtered version of this property.
CIMProperty &	setPropagated (bool propagated=true)
	Set the propagated flag on this property.
bool	getPropagated () const
	Get the propagated flag for this property.
CIMProperty &	clearQualifiers ()
	Clear all qualifiers from this property.
CIMProperty &	clearNonKeyQualifiers ()
	Clear all qualifiers except for the Key qualifier from this property.
virtual String	getName () const
virtual void	setName (const CIMName &name)
	Set the name of this CIMProperty object.
virtual void	writeObject (std::ostream &ostrm) const
	Write this CIMProperty to the given output stream.
virtual void	writeObject (std::ostream &ostrm, WBEMFlags::EIncludeQualifiersFlag includeQualifiers) const
	Write this CIMProperty, optionally omitting all qualifiers except the key qualifier.
virtual void	readObject (std::istream &istrm)
	Read this CIIMProperty 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.
Static Public Attributes
static const char *const	NAME_PROPERTY = "Name"
Private Attributes
COWIntrusiveReference< PROPData >	m_pdata
Friends
OW_COMMON_API bool	operator< (const CIMProperty &x, const CIMProperty &y)
Classes
struct	PROPData

---

Detailed Description

The CIMProperty class encapsulates all data and functionality petinent to a CIM property found in a CIM class or a CIM Instance.

Definition at line 54 of file OW_CIMProperty.hpp.

---

Member Typedef Documentation

typedef COWIntrusiveReference<PROPData> CIMProperty::* OW_NAMESPACE::CIMProperty::safe_bool

Definition at line 110 of file OW_CIMProperty.hpp.

---

Constructor & Destructor Documentation

OW_NAMESPACE::CIMProperty::CIMProperty (   )

Create a new CIMProperty object. Definition at line 96 of file OW_CIMProperty.cpp. Referenced by filter().

OW_NAMESPACE::CIMProperty::CIMProperty (  CIMNULL_t   )  [explicit]

Create a NULL CIMProperty object. Definition at line 101 of file OW_CIMProperty.cpp.

OW_NAMESPACE::CIMProperty::CIMProperty (  const CIMName &  name  )  [explicit]

Create an CIMProperty object with a given name. Parameters: name  The name for this CIMProperty object Definition at line 106 of file OW_CIMProperty.cpp. References m_pdata, and name.

OW_NAMESPACE::CIMProperty::CIMProperty (  const char *  name  )  [explicit]

Create an CIMProperty object with a given name. Parameters: name  The name for this CIMProperty object as a NULL terminated string. Definition at line 112 of file OW_CIMProperty.cpp. References m_pdata.

OW_NAMESPACE::CIMProperty::CIMProperty (  const CIMName &  name, const CIMValue &  value )

Create an CIMProperty object with a name and a value. Parameters: name  The name for this CIMProperty object. value  The value of this CIMProperty Definition at line 118 of file OW_CIMProperty.cpp. References OW_NAMESPACE::CIMValue::getCIMDataType(), m_pdata, and name.

OW_NAMESPACE::CIMProperty::CIMProperty (  const CIMName &  name, const CIMDataType &  dt )

Create an CIMProperty object with a name and a type. Parameters: name  The name for this CIMProperty object. dt  The type of this CIMProperty Definition at line 127 of file OW_CIMProperty.cpp. References m_pdata, and name.

OW_NAMESPACE::CIMProperty::CIMProperty (  const CIMProperty &  arg  )

Copy constructor. Parameters: arg  The CIMProperty to make this object a copy of. Definition at line 135 of file OW_CIMProperty.cpp.

OW_NAMESPACE::CIMProperty::~CIMProperty (   )

Destroy this CIMProperty object. Definition at line 140 of file OW_CIMProperty.cpp.

---

Member Function Documentation

CIMProperty & OW_NAMESPACE::CIMProperty::addQualifier (  const CIMQualifier &  qual  )

Add a qualifier to this property. Parameters: qual  The CIMQualifier to add to this property. Returns: a reference to *this Definition at line 366 of file OW_CIMProperty.cpp. References OW_NAMESPACE::CIMException::ALREADY_EXISTS, OW_NAMESPACE::String::c_str(), OW_NAMESPACE::CIMQualifier::getName(), i, m_pdata, and OW_THROWCIMMSG. Referenced by OW_NAMESPACE::CIMServer::_getNameSpaceClass(), clearNonKeyQualifiers(), OW_NAMESPACE::CIMNameSpaceUtils::create__Namespace(), OW_NAMESPACE::BinaryRequestHandler::createInstance(), OW_NAMESPACE::MOF::CIMOMVisitor::VisitPropertyDeclaration(), and OW_NAMESPACE::MOF::CIMOMVisitor::VisitReferenceDeclaration().

CIMProperty & OW_NAMESPACE::CIMProperty::clearNonKeyQualifiers (   )

Clear all qualifiers except for the Key qualifier from this property. Returns: a reference to *this Definition at line 471 of file OW_CIMProperty.cpp. References addQualifier(), OW_NAMESPACE::CIMQualifier::CIM_QUAL_KEY, getQualifier(), and m_pdata.

CIMProperty & OW_NAMESPACE::CIMProperty::clearQualifiers (   )

Clear all qualifiers from this property. Returns: a reference to *this Definition at line 464 of file OW_CIMProperty.cpp. References m_pdata.

CIMProperty OW_NAMESPACE::CIMProperty::clone (  WBEMFlags::EIncludeQualifiersFlag  includeQualifiers, WBEMFlags::EIncludeClassOriginFlag  includeClassOrigin )  const

Create a copy of this CIMProperty object base on filtering criteria. Parameters: includeQualifiers  If true, include qualifiers of this object. includeClassOrigin  If true, include the class origin of this obj. Returns: A copy of this CIMProperty object Definition at line 158 of file OW_CIMProperty.cpp. References OW_NAMESPACE::WBEMFlags::E_NOT_LOCAL_ONLY, OW_NAMESPACE::CIMDataType::EMBEDDEDINSTANCE, i, and m_pdata.

CIMProperty OW_NAMESPACE::CIMProperty::clone (   )  const [inline]

Returns: A copy of this CIMProperty object. Definition at line 121 of file OW_CIMProperty.hpp. References OW_NAMESPACE::WBEMFlags::E_INCLUDE_CLASS_ORIGIN, and OW_NAMESPACE::WBEMFlags::E_INCLUDE_QUALIFIERS.

CIMProperty OW_NAMESPACE::CIMProperty::filter (  WBEMFlags::ELocalOnlyFlag  localOnly, WBEMFlags::EIncludeQualifiersFlag  includeQualifiers )  const

Create a filtered version of this property. Parameters: localOnly  If true and this property was inherited from another class, then an empty CIMProprty will be return. includeQualifiers  If true, all qualifier on this property will be included in the new CIMProperty. Returns: A CIMProperty object based on the given filtering criteria. Definition at line 413 of file OW_CIMProperty.cpp. References OW_NAMESPACE::CIMNULL, CIMProperty(), and m_pdata.

CIMDataType OW_NAMESPACE::CIMProperty::getDataType (   )  const

Returns: The CIMDataType for this property. Definition at line 283 of file OW_CIMProperty.cpp. References m_pdata. Referenced by OW_NAMESPACE::AssocDb2::addOrDeleteEntries(), OW_NAMESPACE::AssocDbHandle::addOrDeleteEntries(), isKey(), and OW_NAMESPACE::outputKEYVALUE().

String OW_NAMESPACE::CIMProperty::getName (   )  const [virtual]

Returns: The name of this CIMProperty Implements OW_NAMESPACE::CIMElement. Definition at line 452 of file OW_CIMProperty.cpp. References m_pdata. Referenced by OW_NAMESPACE::UtilKeyArray::addElement(), OW_NAMESPACE::AssocDb2::addOrDeleteEntries(), OW_NAMESPACE::AssocDbHandle::addOrDeleteEntries(), OW_NAMESPACE::CIMtoXML(), OW_NAMESPACE::CIMInstance::setProperty(), OW_NAMESPACE::CIMClass::setProperty(), and OW_NAMESPACE::CIMInstance::updatePropertyValue().

String OW_NAMESPACE::CIMProperty::getOriginClass (   )  const

Get the origin class for this property. Returns: The name of the origin class of this property. Definition at line 212 of file OW_CIMProperty.cpp. References m_pdata. Referenced by OW_NAMESPACE::CIMInstance::clone().

String OW_NAMESPACE::CIMProperty::getOverridingProperty (   )  const

Returns: The name of the overriding property. Definition at line 309 of file OW_CIMProperty.cpp. References m_pdata.

bool OW_NAMESPACE::CIMProperty::getPropagated (   )  const

Get the propagated flag for this property. Returns: true if this property is propagated. Otherwise false. Definition at line 446 of file OW_CIMProperty.cpp. References m_pdata.

CIMQualifier OW_NAMESPACE::CIMProperty::getQualifier (  const CIMName &  name  )  const

Get the qualifier associated with the given name from this property. Parameters: name  The name of the qualifier to retrieve. Returns: The CIMQualifier associated with the given name if there is one. Otherwise return a NULL CIMQualifier. Definition at line 321 of file OW_CIMProperty.cpp. References i, m_pdata, and name. Referenced by clearNonKeyQualifiers(), getQualifierT(), and hasTrueQualifier().

CIMQualifierArray OW_NAMESPACE::CIMProperty::getQualifiers (   )  const

Get the qualifiers for this property. Returns: An CIMQualifierArray with the qualifiers for this property Definition at line 199 of file OW_CIMProperty.cpp. References m_pdata. Referenced by OW_NAMESPACE::CIMInstance::createModifiedInstance().

CIMQualifier OW_NAMESPACE::CIMProperty::getQualifierT (  const CIMName &  name  )  const

Get the qualifier associated with the given name from this property. Parameters: name  The name of the qualifier to retrieve. Returns: The CIMQualifier associated with the given name if there is one. Otherwise a NoSuchQualifierException is thrown. Definition at line 336 of file OW_CIMProperty.cpp. References OW_NAMESPACE::String::c_str(), getQualifier(), name, OW_THROW, and OW_NAMESPACE::String::toString().

Int32 OW_NAMESPACE::CIMProperty::getSize (   )  const

Returns: The size of the data associated with this property Definition at line 289 of file OW_CIMProperty.cpp. References m_pdata.

CIMValue OW_NAMESPACE::CIMProperty::getValue (   )  const

Returns: The CIMValue object for this property. The value may be NULL. Definition at line 240 of file OW_CIMProperty.cpp. References m_pdata. Referenced by OW_NAMESPACE::UtilKeyArray::addElement(), OW_NAMESPACE::CIMObjectPath::addKey(), OW_NAMESPACE::NameSpaceProvider::createInstance(), OW_NAMESPACE::CppIndicationExportXMLHTTPProvider::exportIndication(), OW_NAMESPACE::RemoteSecondaryInstanceProvider::filterInstances(), OW_NAMESPACE::NameSpaceProvider::getInstance(), OW_NAMESPACE::CIMObjectPath::getKeyValue(), OW_NAMESPACE::CIMServer::getProperty(), OW_NAMESPACE::CIMRepository2::getProperty(), OW_NAMESPACE::CIMRepository::getProperty(), OW_NAMESPACE::CIMInstance::getPropertyValue(), OW_NAMESPACE::CIMObjectPath::keyHasValue(), OW_NAMESPACE::CIMInstance::propertyHasValue(), and OW_NAMESPACE::CIMInstance::updatePropertyValue().

CIMValue OW_NAMESPACE::CIMProperty::getValueT (   )  const

Returns: The CIMValue object for this property. Exceptions: NULLValueException  if the value is NULL. Definition at line 246 of file OW_CIMProperty.cpp. References m_pdata, and OW_THROW. Referenced by OW_NAMESPACE::CIM_NamespaceInstProv::createInstance(), OW_NAMESPACE::IndicationServerImplThread::createSubscription(), OW_NAMESPACE::CIM_NamespaceInstProv::deleteInstance(), OW_NAMESPACE::CIM_NamespaceInManagerInstProv::getInstance(), and OW_NAMESPACE::getSourceNameSpace().

bool OW_NAMESPACE::CIMProperty::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 615 of file OW_CIMProperty.cpp. References OW_NAMESPACE::CIMDataType::BOOLEAN, getQualifier(), OW_NAMESPACE::CIMValue::getType(), OW_NAMESPACE::CIMQualifier::getValue(), and name. Referenced by isKey().

bool OW_NAMESPACE::CIMProperty::isKey (   )  const

Returns: true if this property has the key qualifier on it. Definition at line 401 of file OW_CIMProperty.cpp. References OW_NAMESPACE::CIMQualifier::CIM_QUAL_KEY, getDataType(), and hasTrueQualifier(). Referenced by OW_NAMESPACE::BinaryRequestHandler::createInstance(), OW_NAMESPACE::CIMInstance::setProperty(), and OW_NAMESPACE::CIMInstance::updatePropertyValue().

bool OW_NAMESPACE::CIMProperty::isReference (   )  const

Returns: true if this property is a reference. Otherwise return false. Definition at line 315 of file OW_CIMProperty.cpp. References m_pdata.

OW_NAMESPACE::CIMProperty::operator safe_bool (   )  const [inline]

Returns: true If this CIMProperty has an implementation. Definition at line 114 of file OW_CIMProperty.hpp. References m_pdata.

bool OW_NAMESPACE::CIMProperty::operator! (   )  const [inline]

Definition at line 116 of file OW_CIMProperty.hpp.

CIMProperty & OW_NAMESPACE::CIMProperty::operator= (  const CIMProperty &  arg  )

Assignment operator. Parameters: arg  The CIMProperty object to assign to this one. Returns: A reference to this object after the assignment is made. Definition at line 151 of file OW_CIMProperty.cpp. References m_pdata.

virtual void OW_NAMESPACE::CIMProperty::readObject (  std::istream &  istrm  )  [virtual]

Read this CIIMProperty object from the given input stream. Parameters: istrm  The input stream to read this CIMElement from. Implements OW_NAMESPACE::SerializableIFC.

bool OW_NAMESPACE::CIMProperty::removeQualifier (  const CIMName &  name  )

Remove a qualifier from this property. Parameters: qname  The name of the qualifier to remove. Returns: true if the qualifier was found and removed. Otherwise false. Definition at line 385 of file OW_CIMProperty.cpp. References i, m_pdata, and name.

CIMProperty & OW_NAMESPACE::CIMProperty::setDataSize (  Int32  size  )

Set the size of the data for this property. Parameters: size  The size of the data associated with property. Returns: a reference to *this Definition at line 295 of file OW_CIMProperty.cpp. References m_pdata.

CIMProperty & OW_NAMESPACE::CIMProperty::setDataType (  const CIMDataType::Type &  type  )

Set the data type for this property. Parameters: type  The CIMDataType::Type for this property Returns: a reference to *this Definition at line 277 of file OW_CIMProperty.cpp. References setDataType().

CIMProperty & OW_NAMESPACE::CIMProperty::setDataType (  const CIMDataType &  type  )

Set the data type for this property. Parameters: type  The CIMDataType for this property Returns: a reference to *this Definition at line 256 of file OW_CIMProperty.cpp. References OW_NAMESPACE::CIMValueCast::castValueToDataType(), OW_NAMESPACE::CIMDataType::EMBEDDEDCLASS, OW_NAMESPACE::CIMDataType::EMBEDDEDINSTANCE, m_pdata, and type. Referenced by OW_NAMESPACE::CIMServer::_getNameSpaceClass(), OW_NAMESPACE::CIMObjectPath::addKey(), OW_NAMESPACE::CIMNameSpaceUtils::create__Namespace(), OW_NAMESPACE::XMLCIMFactory::createProperty(), OW_NAMESPACE::CIMNameSpaceUtils::delete__Namespace(), and setDataType().

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

Set the name of this CIMProperty object. Parameters: name  The new name for this CIMProperty object. Implements OW_NAMESPACE::CIMElement. Definition at line 458 of file OW_CIMProperty.cpp. References m_pdata, and name.

void OW_NAMESPACE::CIMProperty::setNull (   )  [virtual]

Set this to a null object. Implements OW_NAMESPACE::CIMBase. Definition at line 145 of file OW_CIMProperty.cpp. References m_pdata.

CIMProperty & OW_NAMESPACE::CIMProperty::setOriginClass (  const CIMName &  originCls  )

Set the origin class for this property. Parameters: originCls  The name of the origin class of this property. Returns: a reference to *this Definition at line 218 of file OW_CIMProperty.cpp. References m_pdata.

CIMProperty & OW_NAMESPACE::CIMProperty::setOverridingProperty (  const CIMName &  opname  )

Set the overriding property name. Parameters: opname  The name of the overriding property. Returns: a reference to *this Definition at line 302 of file OW_CIMProperty.cpp. References m_pdata.

CIMProperty & OW_NAMESPACE::CIMProperty::setPropagated (  bool  propagated = true  )

Set the propagated flag on this property. Parameters: propagated  If true this property is propagated. Otherwise false. Returns: a reference to *this Definition at line 439 of file OW_CIMProperty.cpp. References m_pdata.

CIMProperty & OW_NAMESPACE::CIMProperty::setQualifier (  const CIMQualifier &  qual  )

Set the value of a qaulifier on this property. Parameters: qual  An CIMQualifier to use to update the property qualifier. Returns: a reference to *this Definition at line 347 of file OW_CIMProperty.cpp. References OW_NAMESPACE::CIMQualifier::getName(), i, and m_pdata. Referenced by OW_NAMESPACE::MOF::CIMOMVisitor::VisitValueInitializer().

CIMProperty & OW_NAMESPACE::CIMProperty::setQualifiers (  const CIMQualifierArray &  quals  )

Set the qualifiers for this property object. Parameters: quals  An CIMQualifierArray with the new qualifiers for this property object. Returns: a reference to *this Definition at line 205 of file OW_CIMProperty.cpp. References m_pdata. Referenced by OW_NAMESPACE::CIMInstance::createModifiedInstance().

CIMProperty & OW_NAMESPACE::CIMProperty::setValue (  const CIMValue &  val  )

Set the value of this property. Parameters: val  The CIMValue for this property. Returns: a reference to *this Definition at line 225 of file OW_CIMProperty.cpp. References OW_NAMESPACE::CIMValueCast::castValueToDataType(), OW_NAMESPACE::CIMDataType::EMBEDDEDCLASS, OW_NAMESPACE::CIMDataType::EMBEDDEDINSTANCE, m_pdata, and val.

String OW_NAMESPACE::CIMProperty::toMOF (   )  const [virtual]

Returns: An String that contains the MOF representation of this CIMProperty object. Implements OW_NAMESPACE::CIMBase. Definition at line 573 of file OW_CIMProperty.cpp. References i, and m_pdata.

String OW_NAMESPACE::CIMProperty::toString (   )  const [virtual]

Returns: The string representation of this CIMProperty. Reimplemented from OW_NAMESPACE::CIMElement. Definition at line 557 of file OW_CIMProperty.cpp. References m_pdata, and OW_NAMESPACE::StringBuffer::releaseString().

virtual void OW_NAMESPACE::CIMProperty::writeObject (  std::ostream &  ostrm, WBEMFlags::EIncludeQualifiersFlag  includeQualifiers )  const [virtual]

Write this CIMProperty, optionally omitting all qualifiers except the key qualifier. Parameters: ostrm  The output stream to write this object to. includeQulifiers  If true write all qualifiers for property

virtual void OW_NAMESPACE::CIMProperty::writeObject (  std::ostream &  ostrm  )  const [virtual]

Write this CIMProperty to the given output stream. Parameters: ostrm  The output stream to write this object to. Implements OW_NAMESPACE::SerializableIFC.

---

Friends And Related Function Documentation

OW_COMMON_API bool operator< (  const CIMProperty &  x, const CIMProperty &  y )  [friend]

Definition at line 609 of file OW_CIMProperty.cpp.

---

Member Data Documentation

COWIntrusiveReference<PROPData> OW_NAMESPACE::CIMProperty::m_pdata [private]

Definition at line 327 of file OW_CIMProperty.hpp. Referenced by addQualifier(), CIMProperty(), clearNonKeyQualifiers(), clearQualifiers(), clone(), filter(), getDataType(), getName(), getOriginClass(), getOverridingProperty(), getPropagated(), getQualifier(), getQualifiers(), getSize(), getValue(), getValueT(), isReference(), operator safe_bool(), OW_NAMESPACE::operator<(), operator=(), removeQualifier(), setDataSize(), setDataType(), setName(), setNull(), setOriginClass(), setOverridingProperty(), setPropagated(), setQualifier(), setQualifiers(), setValue(), toMOF(), and toString().

const char *const OW_NAMESPACE::CIMProperty::NAME_PROPERTY = "Name" [static]

Definition at line 57 of file OW_CIMProperty.hpp. Referenced by OW_NAMESPACE::CIMServer::_getNameSpaceClass(), OW_NAMESPACE::NameSpaceProvider::createInstance(), OW_NAMESPACE::BinaryRequestHandler::createInstance(), and OW_NAMESPACE::NameSpaceProvider::getInstance().

---

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

• OW_CIMProperty.hpp
• OW_CIMProperty.cpp

---