Pegasus Developers Manual

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

class PEGASUS_COMMON_LINKAGE CIMMethod

Class CIMMethod - This class defines the operations associated with manipulation of the Pegasus implementation of the CIM CIMMethod.

Documentation

Class CIMMethod - This class defines the operations associated with manipulation of the Pegasus implementation of the CIM CIMMethod. Within this class, methods are provides for creation, deletion, and manipulation of method declarations.
// ATTN: remove the classOrigin and propagated parameters.

Inheritance:

Public Methods

CIMMethod()

Creates and instantiates a CIM method.

CIMMethod(const CIMMethod& x)

Creates and instantiates a CIM method from another method instance


Returns:: pointer to the new method instance

CIMMethod& operator=(const CIMMethod& x)

Assignment operator

CIMMethod( const String& name, CIMType type, const String& classOrigin = String(), Boolean propagated = false)

Creates a CIM method with the specified name, type, and classOrigin


Parameters:: name - for the method
type - ATTN
classOrigin -
propagated -
Returns:: Throws IllegalName if name argument not legal CIM identifier.

~CIMMethod()

Desctructor.

const String& getName() const

getName - Gets the name of the method


Returns:: String with the name of the method

void setName(const String& name)

setName - Set the method name


Throws:: IllegalName if name argument not legal CIM identifier.
Parameters:: name -

CIMType getType() const

getType - gets the method type


Returns:: The CIM method type for this method.

void setType(CIMType type)

setType - Sets the method type to the specified CIM method type as defined in CIMType /Ref{TYPE}

const String& getClassOrigin() const

getClassOrigin - Returns the class in which this method was defined.


Returns:: ATTN:

void setClassOrigin(const String& classOrigin)

setClassOrigin - ATTN:

Boolean getPropagated() const

getPropagated - Tests the propogated qualifier


Returns:: - returns True if method is propogated

void setPropagated(Boolean propagated)

setPropagated - Sets the Propagaged Qualifier

CIMMethod& addQualifier(const CIMQualifier& x)

addQualifier - Adds a Qualifier to the method object.


Throws:: AlreadyExists exception
Parameters:: - CIMQualifier to be added
Returns:: Throws AlreadyExists excetpion if the qualifier already exists in the method

Uint32 findQualifier(const String& name)

findQualifier - returns the position of the qualifier with the given name.


Parameters:: name - Name of qualifier to be found.
Returns:: index of the parameter if found; otherwise PEG_NOT_FOUND.

Boolean existsQualifier(const String& name)

existsQualifier - returns the position of the qualifier with the given name.


Parameters:: name - Name of qualifier to be found.
Returns:: index of the parameter if found; otherwise PEG_NOT_FOUND.

CIMQualifier getQualifier(Uint32 pos)

getQualifier - Gets the CIMQualifier defined by the index input as a parameter.


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

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 the number of Qualifiers attached to this CIMmethod object.


Returns:: integer representing number of Qualifiers.

CIMMethod& addParameter(const CIMParameter& x)

addParameter - Adds the parameter defined by the input to the CIMMethod

Uint32 findParameter(const String& name)

findParameter - Finds the parameter whose name is given by the name parameter.


Parameters:: name - Name of parameter to be found.
Returns:: index of the parameter if found; otherwise PEG_NOT_FOUND.

CIMParameter getParameter(Uint32 pos)

getParameter - ATTN:

CIMConstParameter getParameter(Uint32 pos) const

getParameter - Gets the parameter defined by the index input as a parameter.


Parameters:: index - for the parameter to be returned.
Returns:: CIMParameter requested. @Exception OutOfBounds exception is thrown if the index is outside the range of available parameters

Uint32 getParameterCount() const

getParameterCount - Gets the count of the numbeer of Parameters attached to the CIMMethod. @retrun - count of the number of parameters attached to the CIMMethod.

void resolve( DeclContext* declContext, const String& nameSpace, const CIMConstMethod& method)

resolve - resolves and completes the CIMMethod

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

resolve - Resolves and completes the CIMMethod

operator int() const

Returns zero if CIMMethod refers to a null pointer

void toXml(Array<Sint8>& out) const

toXML - puts XML encoding of this CIMMethod object into out arguemnt.

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

print - formats and prints this CIMmethod (in CIM XML encoded form).

void toMof(Array<Sint8>& out) const

toMof - puts MOF encoding of this object into out arguemnt.

Boolean identical(const CIMConstMethod& x) const

identical - Returns true if this method is identical to the one given by the argument x

CIMMethod clone() const

CIMMethod clone - makes a distinct replica of this method

This class has no child classes.


Friends:: class CIMConstMethod
class CIMClassRep

Alphabetic index HTML hierarchy of classes or Java

class PEGASUS_COMMON_LINKAGE CIMMethod

Documentation

Inheritance:

Public Methods