Pegasus Developers Manual

In file ..\..\src\Pegasus\Common\CIMProperty.h:

class PEGASUS_COMMON_LINKAGE CIMProperty

CIMProperty Class - This C++ class implements the CIM Property Object.

Documentation

CIMProperty Class - This C++ class implements the CIM Property Object. It defines a single CIM Property and allows the manipulation of that property. A CIM property is a value used to characterize an instance of a class. ANNT: This is a very poor definition. ATTN: Define the property concept in more detail and ref property.

Inheritance:

Public Methods

CIMProperty()

CIMProperty constructor.

CIMProperty(const CIMProperty& x)

CIMProperty.

CIMProperty( const String& name, const CIMValue& value, Uint32 arraySize = 0, const String& referenceClassName = String::EMPTY, const String& classOrigin = String(), Boolean propagated = false)

CIMProperty Constructor for CIMProperty that adds a number of parameters to the constructed CIMProperty object.


Throws:: Throws "IllegalName" if name argumentis not legal a CIM name /Ref{CIMName}.
Parameters:: name - String Name for the property
value - CIMValue defines the value for the property
arraySize - (optional) - ATTN - TBD
referenceClassName - (optional) String parameter that defines the reference class name for the property. /Ref{referenceClassName}
classOrigin - (optional) String parameter to define the class origin of the property /Ref{ClassOrigin}
propagated - (optional) If true defines the property as propagated /Ref{propagated properties}
Returns:: The constructed property object

~CIMProperty()

~CIMProperty().

CIMProperty& operator=(const CIMProperty& x)

Operator =

const String& getName() const

getName - Gets the name of the property.

Returns:

String containing the property name.

CIMProperty p1("count", Uint32(231));
assert(p1.getName() == Uint32(231));

void setName(const String& name)

setName - Set the property name. Throws IllegalName if name argument not legal CIM identifier.


Throws:: Throws "IllegalName" exception is name is not legal syntax.
Parameters:: - - Name to set

const CIMValue& getValue() const

Get the value of the property.

CIMType getType() const

Get the type of the property.

void setValue(const CIMValue& value)

setValue Sets the Value in the Property object from the input parameter.


Parameters:: value - CIMValue containing the value to be put into the property. /Ref{CIMValue}

Uint32 getArraySize() const

getArraySize - ATTN:

const String& getReferenceClassName() const

getReferenceClassName - ATTN:

const String& getClassOrigin() const

getClassOrigin - ATTN

void setClassOrigin(const String& classOrigin)

setClassOrigin - Sets the Class Origin

Boolean getPropagated() const

getPropagated - Tests if this property is propogated.


Returns:: - Returns true if the class is propogated.

void setPropagated(Boolean propagated)

setProgagated - ATTN

CIMProperty& addQualifier(const CIMQualifier& x)

addQualifier - ATTN Throws AlreadyExists

Uint32 findQualifier(const String& name)

findQualifier - Finds the qualifier object defined by the name parameter if it is attached to this CIMProperty


Parameters:: name - String parameter defining name of Qualifier object.
Returns:: Position of the qualifier object or -1 if not found

Boolean existsQualifier(const String& name)

existsQualifier - Determines if the qualifier object defined by the name parameter is attached to this CIMProperty.


Parameters:: name - String parameter defining name of Qualifier object.
Returns:: Returns true if the qualifier is found, else returns false.

CIMQualifier getQualifier(Uint32 pos)

getQualifier - gets the Qualifier object specified by the pos parameter.


Throws:: Throws OutOfBounds if pos is outside range of Qualifiers in this property object.
Parameters:: pos - Position parameter for the Qualifier object to be retrieved
Returns:: returns a CIMQualifier object.

CIMConstQualifier getQualifier(Uint32 pos) const

CIMMethod getQualifier - ATTN

void removeQualifier(Uint32 pos)

removeQualifier - Removes the CIMQualifier defined by the position input as a parameter.


Throws:: OutOfBounds exception if the index is outside the range of parameters available from the CIMMethod.
Parameters:: Position - of the qualifier requested.
Returns:: CIMQualifier object or exception

Uint32 getQualifierCount() const

getQualifierCount - Returns count of the number of qualifiers attached to the CIMProperty object.


Returns:: Count of the number of CIMQualifier objects attached to the CIMProperty object.

void resolve( DeclContext* declContext, const String& nameSpace, Boolean isInstancePart, const CIMConstProperty& property)

CIMMethod resolve

void resolve( DeclContext* declContext, const String& nameSpace, Boolean isInstancePart)

resolve - ATTN

operator int() const

ATTN

void toXml(Array<Sint8>& out) const

toXML - Converts the object to XML and puts the resutl in the out parameter


Parameters:: out - Parameter for XML output

void print(PEGASUS_STD(ostream) &o=PEGASUS_STD(cout)) const

print - Converts the object to XML and output it to cout

void toMof(Array<Sint8>& out) const

toMof - Converts the object to Mof and puts the resutl in the out parameter


Parameters:: out - Parameter for Mof output

Boolean identical(const CIMConstProperty& x) const

identical - compares the CIMProperty object with another CIMProperty object defined by the input parameter.


Parameters:: - x CIMPropery object for comparison
Returns:: Returns true if the objects are identical

Boolean isKey() const

isKey - Tests the CIMProperty to determine if any qualifiers is a key indicating that this is a key property


Returns:: Returns true if this is a key property.

CIMProperty clone() const

clone - ATTN

This class has no child classes.


Friends:: class CIMConstProperty
class CIMClassRep
class CIMInstanceRep

Alphabetic index HTML hierarchy of classes or Java

class PEGASUS_COMMON_LINKAGE CIMProperty

Documentation

Inheritance:

Public Methods