pegasus/src/Pegasus/Common/CIMMethod.h - diff

Return to CIMMethod.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMMethod.h between version 1.17.2.1 and 1.49.2.1

version 1.17.2.1, 2001/08/01 11:17:36

version 1.49.2.1, 2006/02/10 16:09:34

Line 1

//%/////////////////////////////////////////////////////////////////////////////

//%2006////////////////////////////////////////////////////////////////////////

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a copy

// of this software and associated documentation files (the "Software"), to

Line 20

Line 29

//==============================================================================

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By:

//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_Method_h

#define Pegasus_Method_h

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/CIMMethodRep.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/String.h>

#include <Pegasus/Common/CIMName.h>

#include <Pegasus/Common/CIMParameter.h>

#include <Pegasus/Common/CIMQualifier.h>

#include <Pegasus/Common/CIMType.h>

PEGASUS_NAMESPACE_BEGIN

class Resolver;

class CIMConstMethod;

class CIMMethodRep;

/** Class CIMMethod - This class defines the operations associated with

/** The CIMMethod class is used to represent CIM methods in Pegasus.

manipulation of the Pegasus implementation of the CIM CIMMethod. Within

A CIMMethod consists of the following entities:

this class, methods are provides for creation, deletion, and manipulation

<ul>

of method declarations.

<li>Name of the method, a CIMName.

// ATTN: remove the classOrigin and propagated parameters.

<li>CIM type of the method return value, a CIMType.

<li>Optional qualifiers (see CIMQualifier) for the method.

A method can contain zero or more CIMQualifier objects.

<li>Optional parameters (see CIMParameter) for the method.

A CIMMethod may contain zero or more CIMParameter objects.

</ul>

In addition, a CIMMethod contains the following internal attributes:

<ul>

<li>propagated - An attribute defining whether this CIMMethod is

propagated from a superclass. Note that this is normally set as part

of completing the definition of objects (resolving) when they are

created as part of a CIM schema and is NOT automatically set when

creating a local object. It can only be logically set in context of

the schema in which the CIMMethod is defined.

<li>classOrigin - An attribute defining the class in which

this CIMMethod was originally defined. This is normally set within the

context of the schema in which the CIMMethod is defined.

This attribute is available from objects retrieved from the CIM

Server, for example, and provides information on the defintion

of this method in the class hierarchy. Together the

propagated and ClassOrigin attributes can be used to determine if

methods originated with the current object or were inherited from

higher levels in the hiearchy.

</ul>

A CIMMethod is generally defined in the context of a CIMClass.

CIMMethod uses shared representations, meaning that multiple

CIMMethod objects may refer to the same copy of data. Assignment and copy

operators create new references to the same data, not distinct copies.

A distinct copy may be created using the clone method.

{@link Shared Classes}

@see CIMConstMethod

@see CIMParameter

@see CIMQualifier

@see CIMType

@see CIMClass

class PEGASUS_COMMON_LINKAGE CIMMethod

{

public:

/** Creates and instantiates a CIM method. */

/** Creates a new uninitialized CIMMethod object.

CIMMethod() : _rep(0)

The only thing that can be done with this object is to copy another

{

object into it. Other methods, such as setName, will fail with an

UninitializedObjectException. The object has an uninitialized state,

}

which can be tested with the isUninitialized method.

@see isUninitialized()

/** Creates and instantiates a CIM method from another method instance

@see UninitializedObjectException

@return pointer to the new method instance

CIMMethod();

CIMMethod(const CIMMethod& x)

{

/** Creates a new CIMMethod object from another CIMMethod object.

Inc(_rep = x._rep);

The new CIMMethod object references the same copy of data as the

}

specified object; no copy is made.

@param x CIMMethod object from which to create the new CIMMethod object.

/** Assignment operator */

Example:

CIMMethod& operator=(const CIMMethod& x)

<pre>

{

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

if (x._rep != _rep)

const CIMMethod cm1(m1);

{

</pre>

Dec(_rep);

{@link Shared Classes}

Inc(_rep = x._rep);

}

CIMMethod(const CIMMethod& x);

return *this;

}

/** Creates a CIMMethod object with the specified attributes.

@param name CIMName defining the name for the method.

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

@param name for the method

@param type CIMType defining the method return type.

@param type ATTN

@param classOrigin

@param classOrigin (optional) CIMName representing the class origin.

@param propagated

Note that this should normally not be used. If not provided set to

@return Throws IllegalName if name argument not legal CIM identifier.

CIMName() (Null name).

@param propagated Optional flag indicating whether the definition of

the CIM Method is local to the CIM Class (respectively, Instance)

in which it appears, or was propagated without modification from

a superclass. Default is false. Note that this attribute is

normally not set by CIM Clients but is used internally within the

CIM Server.

Example:

<pre>

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

</pre>

CIMMethod(

const String& name,

const CIMName& name,

CIMType type,

const String& classOrigin = String(),

const CIMName& classOrigin = CIMName(),

Boolean propagated = false)

Boolean propagated = false);

{

_rep = new CIMMethodRep(name, type, classOrigin, propagated);

}

/** Desctructor. */

~CIMMethod()

{

Dec(_rep);

}

/** getName - Gets the name of the method

@return String with the name of the method

const String& getName() const

{

_checkRep();

return _rep->getName();

}

/** setName - Set the method name

@param name

@exception IllegalName if name argument not legal CIM identifier.

void setName(const String& name)

{

_checkRep();

_rep->setName(name);

}

/** getType - gets the method type

@return The CIM method type for this method.

CIMType getType() const

{

_checkRep();

return _rep->getType();

}

/** setType - Sets the method type to the specified CIM method

/** Destructor for the CIMMethod. The shared data copy remains valid until

type as defined in CIMType /Ref{TYPE}

all referring objects are destructed.

{@link Shared Classes}

void setType(CIMType type)

{

~CIMMethod();

_checkRep();

_rep->setType(type);

/** The assignment operator assigns one CIMMethod to another.

}

After the assignment, both CIMMethod objects refer to the same

data copy; a distinct copy is not created.

/** getClassOrigin - Returns the class in which this method

@param x CIMMethod object from which to assign this CIMMethod object.

was defined.

@return ATTN:

Example:

<pre>

const String& getClassOrigin() const

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

{

CIMMethod m2;

_checkRep();

m2 = m1;

return _rep->getClassOrigin();

</pre>

}

CIMMethod& operator=(const CIMMethod& x);

/** setClassOrigin - ATTN: */

void setClassOrigin(const String& classOrigin)

/** Gets the name of the method.

{

@return CIMName with the name of the method.

_checkRep();

Example:

_rep->setClassOrigin(classOrigin);

<pre>

}

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

assert(m1.getName() == CIMName ("getHostName"));

/** getPropagated - Tests the propogated qualifier

</pre>

@return - returns True if method is propogated

const CIMName& getName() const;

Boolean getPropagated() const

{

/** Sets the method name.

_checkRep();

@param name CIMName for the method name. Replaces any

return _rep->getPropagated();

previously defined name for this method object.

}

Example:

<pre>

/** setPropagated - Sets the Propagaged Qualifier */

CIMMethod m2(CIMName ("test"), CIMTYPE_STRING);

void setPropagated(Boolean propagated)

m2.setName(CIMName ("getVersion"));

{

</pre>

_checkRep();

_rep->setPropagated(propagated);

void setName(const CIMName& name);

}

/** Gets the method return type.

/** addQualifier - Adds a Qualifier to the method object.

@return A CIMType containing the method return type.

@param CIMQualifier to be added

@exception UninitializedObjectException Thrown if the object is not

@return Throws AlreadyExists excetpion if the qualifier already exists

initialized.

in the method

Example:

@exception AlreadyExists exception

<pre>

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

CIMMethod& addQualifier(const CIMQualifier& x)

assert(m1.getType() == CIMTYPE_STRING);

{

</pre>

_checkRep();

_rep->addQualifier(x);

CIMType getType() const;

return *this;

}

/** Sets the method return type to the specified CIMType.

This is the type of the CIMValue

/** findQualifier - returns the position of the qualifier with

that is returned on a CIM method invocation.

the given name.

@param type CIMType to be set into the CIMMethod object.

@param name Name of qualifier to be found.

@exception UninitializedObjectException Thrown if the object is not

@return index of the parameter if found; otherwise PEG_NOT_FOUND.

initialized.

Example:

Uint32 findQualifier(const String& name)

<pre>

{

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

_checkRep();

m1.setName(CIMName ("getVersion"));

return _rep->findQualifier(name);

assert(m1.getName() == CIMName ("getVersion"));

}

</pre>

Uint32 findQualifier(const String& name) const

void setType(CIMType type);

{

_checkRep();

/** Gets the class in which this method was defined. This information

return _rep->findQualifier(name);

is normally available with methods that are part of a schema

}

returned from a CIM Server.

@return CIMName containing the classOrigin attribute.

/** existsQualifier - returns the position of the qualifier with

the given name.

const CIMName& getClassOrigin() const;

@param name Name of qualifier to be found.

@return index of the parameter if found; otherwise PEG_NOT_FOUND.

/** Sets the classOrigin attribute with the specified class name.

Normally this method is used internally by a CIM Server when

Boolean existsQualifier(const String& name)

defining methods in the context of a schema.

{

@param classOrigin CIMName parameter defining the name

_checkRep();

of the origin class.

return _rep->existsQualifier(name);

@exception UninitializedObjectException Thrown if the object is not

}

initialized.

Boolean existsQualifier(const String& name) const

void setClassOrigin(const CIMName& classOrigin);

{

_checkRep();

/** Tests the propagated attribute of the object. The propagated

return _rep->existsQualifier(name);

attribute indicates whether this method was propagated from a

}

higher-level class. Normally this attribute is set as part of

defining a method in the context of a schema. It is set in

methods retrieved from a CIM Server.

/** getQualifier - Gets the CIMQualifier defined by the index

@return True if method is propagated; otherwise, false.

input as a parameter.

@param Index of the qualifier requested.

Boolean getPropagated() const;

@return CIMQualifier object or exception

@exception OutOfBounds exception if the index is outside the range of

/** Sets the propagated attribute. Normally this is used by a CIM Server

parameters available from the CIMMethod.

when defining a method in the context of a schema.

@param propagated Flag indicating whether the method is propagated

CIMQualifier getQualifier(Uint32 pos)

from a superclass.

{

@exception UninitializedObjectException Thrown if the object is not

_checkRep();

initialized.

return _rep->getQualifier(pos);

}

void setPropagated(Boolean propagated);

CIMConstQualifier getQualifier(Uint32 pos) const

/** Adds the specified qualifier to the CIMMethod object.

{

@param x CIMQualifier object representing the qualifier

_checkRep();

to be added.

return _rep->getQualifier(pos);

@return The CIMMethod object after adding the specified qualifier.

}

@exception AlreadyExistsException Thrown if the qualifier already

exists in this CIMMethod.

/** removeQualifier - Removes the CIMQualifier defined by the

Example:

position input as a parameter.

<pre>

@param Position of the qualifier requested.

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

@return CIMQualifier object or exception

m1.addQualifier(CIMQualifier(CIMName ("stuff"), true));

@exception OutOfBounds exception if the index is outside the range of

</pre>

parameters available from the CIMMethod.

CIMMethod& addQualifier(const CIMQualifier& x);

void removeQualifier(Uint32 pos)

{

/** Searches for a qualifier with the specified input name.

_checkRep();

@param name CIMName of the qualifier to be found.

_rep->removeQualifier(pos);

@return Zero origin index of the qualifier found or PEG_NOT_FOUND

}

if not found.

@exception UninitializedObjectException Thrown if the object is not

initialized.

/** getQualifierCount - Returns the number of Qualifiers attached

Example:

to this CIMmethod object.

<pre>

@return integer representing number of Qualifiers.

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

m1.addQualifier(CIMQualifier(CIMName ("stuff"), true));

Uint32 getQualifierCount() const

assert(m1.findQualifier(CIMName ("stuff")) != PEG_NOT_FOUND);

{

</pre>

_checkRep();

return _rep->getQualifierCount();

Uint32 findQualifier(const CIMName& name) const;

}

/** Gets the CIMQualifier defined by the input parameter.

/** addParameter - Adds the parameter defined by the input

@param index Zero origin index of the qualifier requested.

to the CIMMethod

@return CIMQualifier object representing the qualifier found.

@exception IndexOutOfBoundsException Thrown if the index is

CIMMethod& addParameter(const CIMParameter& x)

outside the range of parameters available from the CIMMethod.

{

Example:

_checkRep();

<pre>

_rep->addParameter(x);

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

return *this;

m1.addQualifier(CIMQualifier(CIMName ("stuff"), true));

}

Uint32 posQualifier = m1.findQualifier(CIMName ("stuff"));

if (posQualifier != PEG_NOT_FOUND)

/** findParameter - Finds the parameter whose name is given

{

by the name parameter.

CIMQualifier q = m1.getQualifier(posQualifier);

@param name Name of parameter to be found.

}

@return index of the parameter if found; otherwise PEG_NOT_FOUND.

</pre>

Uint32 findParameter(const String& name)

CIMQualifier getQualifier(Uint32 index);

{

_checkRep();

/** Gets the CIMQualifier defined by the input parameter.

return _rep->findParameter(name);

@param index Zero origin index of the qualifier requested.

}

@return CIMQualifier object representing the qualifier found.

@exception IndexOutOfBoundsException Thrown if the index is

Uint32 findParameter(const String& name) const

outside the range of parameters available from the CIMMethod.

{

Example:

_checkRep();

<pre>

return _rep->findParameter(name);

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

}

m1.addQualifier(CIMQualifier(CIMName ("stuff"), true));

const CIMMethod m2 = m1;

/** getParameter - ATTN: */

Uint32 posQualifier = m2.findQualifier(CIMName ("stuff"));

CIMParameter getParameter(Uint32 pos)

if (posQualifier != PEG_NOT_FOUND)

{

_checkRep();

CIMConstQualifier q = m2.getQualifier(posQualifier);

return _rep->getParameter(pos);

}

</pre>

/** getParameter - Gets the parameter defined by the index

CIMConstQualifier getQualifier(Uint32 index) const;

input as a parameter.

@param index for the parameter to be returned.

/** Removes the specified qualifier from this method.

@return CIMParameter requested.

@param index Index of the qualifier to remove.

@Exception OutOfBounds exception is thrown if the index is outside the

@exception IndexOutOfBoundsException Thrown if the index is

range of available parameters

outside the range of parameters available from the CIMMethod.

Example:

CIMConstParameter getParameter(Uint32 pos) const

<pre>

{

// remove all qualifiers from a class

_checkRep();

Uint32 count = 0;

return _rep->getParameter(pos);

while((count = cimClass.getQualifierCount()) > 0)

}

cimClass.removeQualifier(count - 1);

</pre>

/** getParameterCount - Gets the count of the numbeer of

Parameters attached to the CIMMethod.

void removeQualifier(Uint32 index);

@retrun - count of the number of parameters attached to the CIMMethod.

/** Returns the number of Qualifiers attached to this CIMMethod object.

Uint32 getParameterCount() const

@return The number of qualifiers attached to the CIM Method.

{

Example:

_checkRep();

<pre>

return _rep->getParameterCount();

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

}

m1.addQualifier(CIMQualifier(CIMName ("stuff"), true));

m1.addQualifier(CIMQualifier(CIMName ("stuff2"), true));

/** resolve - resolves and completes the CIMMethod */

assert(m1.getQualifierCount() == 2);

void resolve(

</pre>

DeclContext* declContext,

const String& nameSpace,

Uint32 getQualifierCount() const;

const CIMConstMethod& method)

{

/** Adds the parameter defined by the input to the CIMMethod.

_checkRep();

@param x CIMParameter to be added to the CIM Method.

_rep->resolve(declContext, nameSpace, method);

@return CIMMethod object after the specified parameter is added.

}

Example:

@exception UninitializedObjectException Thrown if the object is not

/** resolve - Resolves and completes the CIMMethod */

initialized.

void resolve(

@exception AlreadyExistsException Thrown if the parameter already

DeclContext* declContext,

exists in this CIMMethod.

const String& nameSpace)

<pre>

{

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

_checkRep();

m1.addParameter(CIMParameter(CIMName ("ipaddress"), CIMTYPE_STRING));

_rep->resolve(declContext, nameSpace);

</pre>

}

CIMMethod& addParameter(const CIMParameter& x);

/** Returns zero if CIMMethod refers to a null pointer */

operator int() const

/** Finds the parameter with the specified name.

{

@param name CIMName of parameter to be found.

return _rep != 0;

@return Index of the parameter object found or PEG_NOT_FOUND

}

if the property is not found.

Example:

/** toXML - puts XML encoding of this CIMMethod object into out

<pre>

arguemnt.

Uint32 posParameter;

posParameter = m1.findParameter(CIMName ("ipaddress"));

void toXml(Array<Sint8>& out) const

if (posParameter != PEG_NOT_FOUND)

{

...

_checkRep();

</pre>

_rep->toXml(out);

}

Uint32 findParameter(const CIMName& name) const;

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

/** Gets the parameter defined by the specified index.

@param index Index for the parameter to be returned.

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

@return CIMParameter object requested.

{

@exception IndexOutOfBoundsException Thrown if the index is outside

_checkRep();

the range of available parameters.

_rep->print(o);

Example:

}

<pre>

CIMParameter cp;

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

Uint32 parameterIndex = m1.findParameter(CIMName ("ipaddress"));

if (parameterIndex != PEG_NOT_FOUND)

void toMof(Array<Sint8>& out) const

{

cp = m1.getParameter(parameterIndex);

_checkRep();

}

_rep->toMof(out);

</pre>

}

CIMParameter getParameter(Uint32 index);

/** identical - Returns true if this method is identical to the

one given by the argument x.

/** Gets the parameter defined by the specified index.

@param index Index for the parameter to be returned.

@return CIMParameter object requested.

@exception IndexOutOfBoundsException Thrown if the index is outside

the range of available parameters.

Example:

<pre>

CIMConstParameter cp;

Uint32 parameterIndex = m1.findParameter(CIMName ("ipaddress"));

if (parameterIndex != PEG_NOT_FOUND)

{

cp = m1.getParameter(parameterIndex);

}

</pre>

CIMConstParameter getParameter(Uint32 index) const;

/** Removes the parameter defined by the specified index.

@param index Index of the parameter to be removed.

@exception IndexOutOfBoundsException Thrown if the index is outside the

range of parameters available from the CIMMethod.

void removeParameter (Uint32 index);

/** Gets the count of Parameters defined in the CIMMethod.

@return Count of the number of parameters attached to the CIMMethod.

Uint32 getParameterCount() const;

/** Determines if the object has not been initialized.

@return True if the object has not been initialized;

otherwise, false.

Example:

<pre>

CIMMethod m1;

assert(m1.isUninitialized());

</pre>

Boolean isUninitialized() const;

/** Compares with a CIMConstMethod.

@param x CIMConstMethod object for the method to be compared.

@return True if this method is identical to the one specified;

otherwise, false.

Example:

<pre>

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

CIMConstMethod m2(CIMName ("test"), CIMTYPE_STRING);

assert(!m1.identical(m2));

</pre>

Boolean identical(const CIMConstMethod& x) const;

/** CIMMethod clone - makes a distinct replica of this method */

/** Makes a clone (deep copy) of this method. This creates

CIMMethod clone() const

a new copy of all of the components of the method including

{

parameters and qualifiers.

return CIMMethod(_rep->clone());

@return Independent copy of the CIMMethod object.

}

CIMMethod clone() const;

private:

CIMMethod(CIMMethodRep* rep) : _rep(rep)

CIMMethod(CIMMethodRep* rep);

{

}

/** This method is not implemented. It is defined to explicitly disallow

construction of a CIMMethod from a CIMConstMethod. Because the

CIMMethod class uses a shared representation model, allowing this

construction would effectively allow modification of CIMConstMethod

objects.

PEGASUS_EXPLICIT CIMMethod(const CIMConstMethod& x);

void _checkRep() const

void _checkRep() const;

{

if (!_rep)

ThrowUnitializedHandle();

}

CIMMethodRep* _rep;

friend class CIMConstMethod;

friend class CIMClassRep;

friend class Resolver;

friend class XmlWriter;

friend class MofWriter;

friend class BinaryStreamer;

};

/** The CIMConstMethod class is used to represent CIM methods in the

same manner as the CIMMethod class except that the const attribute

is applied to the objects created. This class includes equivalents

to the methods from CIMMethod that are available in a const object,

including constructors, accessor methods, and the destructor.

Because the CIMMethod class uses a shared representation model, allowing

the construction of a 'CIMMethod' from a 'const CIMMethod' would

effectively allow modification of a 'const CIMMethod'. The CIMConstMethod

class is used to represent constant CIMMethod objects. Since a

CIMConstMethod cannot be converted to a CIMMethod, its value remains

constant.

@see CIMMethod()

class PEGASUS_COMMON_LINKAGE CIMConstMethod

{

public:

CIMConstMethod() : _rep(0)

/** Creates a new uninitialized CIMConstMethod object.

{

The only thing that can be done with this object is to copy another

object into it. Other methods, such as getName, will fail with an

}

UninitializedObjectException. The object has an uninitialized state,

which can be tested with the isUninitialized method.

CIMConstMethod(const CIMConstMethod& x)

@see isUninitialized()

{

@see UninitializedObjectException

Inc(_rep = x._rep);

}

CIMConstMethod();

CIMConstMethod(const CIMMethod& x)

/** Creates a new CIMConstMethod object from another CIMConstMethod object.

{

The new CIMConstMethod object references the same copy of data as the

Inc(_rep = x._rep);

specified object; no copy is made.

}

@param x CIMConstMethod object from which to create the new

CIMConstMethod object.

CIMConstMethod& operator=(const CIMConstMethod& x)

Example:

{

<pre>

if (x._rep != _rep)

CIMConstMethod cm1(CIMName ("getHostName"), CIMTYPE_STRING);

{

CIMConstMethod cm2(m1);

Dec(_rep);

</pre>

Inc(_rep = x._rep);

{@link Shared Classes}

}

return *this;

CIMConstMethod(const CIMConstMethod& x);

}

/** Creates a new CIMConstMethod object from a CIMMethod object.

CIMConstMethod& operator=(const CIMMethod& x)

The new CIMConstMethod object references the same copy of data as the

{

specified object; no copy is made.

if (x._rep != _rep)

@param x CIMMethod object from which to create the new

{

CIMConstMethod object.

Dec(_rep);

Example:

Inc(_rep = x._rep);

<pre>

}

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

return *this;

CIMConstMethod cm1(m1);

}

</pre>

{@link Shared Classes}

// Throws IllegalName if name argument not legal CIM identifier.

CIMConstMethod(const CIMMethod& x);

/** Creates a CIMConstMethod object with the specified attributes.

@param name CIMName defining the name for the method.

@param type CIMType defining the method return type.

@param classOrigin (optional) CIMName representing the class origin.

Note that this should normally not be used. If not provided set to

CIMName() (Null name).

@param propagated Optional flag indicating whether the definition of

the CIM Method is local to the CIM Class (respectively, Instance)

in which it appears, or was propagated without modification from

a superclass. Default is false. Note that this attribute is

normally not set by CIM Clients but is used internally within the

CIM Server.

Example:

<pre>

CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

</pre>

CIMConstMethod(

const String& name,

const CIMName& name,

CIMType type,

const String& classOrigin = String(),

const CIMName& classOrigin = CIMName(),

Boolean propagated = false)

Boolean propagated = false);

{

_rep = new CIMMethodRep(name, type, classOrigin, propagated);

}

~CIMConstMethod()

{

Dec(_rep);

}

const String& getName() const

/** Destructor for the CIMConstMethod. The shared data copy remains valid

{

until all referring objects are destructed.

_checkRep();

{@link Shared Classes}

return _rep->getName();

}

~CIMConstMethod();

CIMType getType() const

/** The assignment operator assigns one CIMConstMethod to another.

{

After the assignment, both CIMConstMethod objects refer to the same

_checkRep();

data copy; a distinct copy is not created.

return _rep->getType();

@param x CIMConstMethod object from which to assign this

}

CIMConstMethod object.

const String& getClassOrigin() const

Example:

{

<pre>

_checkRep();

CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

return _rep->getClassOrigin();

CIMConstMethod m2;

}

m2 = m1;

</pre>

Boolean getPropagated() const

{

CIMConstMethod& operator=(const CIMConstMethod& x);

_checkRep();

return _rep->getPropagated();

/** The assignment operator assigns a CIMMethod object to a

}

CIMConstMethod.

After the assignment, both objects refer to the same

Uint32 findQualifier(const String& name) const

data copy; a distinct copy is not created.

{

@param x CIMConstMethod object from which to assign this

_checkRep();

CIMConstMethod object.

return _rep->findQualifier(name);

}

Example:

<pre>

Uint32 getQualifier(Uint32 pos) const

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

{

CIMConstMethod m2;

_checkRep();

m2 = m1;

return _rep->getQualifier(pos);

</pre>

}

CIMConstMethod& operator=(const CIMMethod& x);

Uint32 getQualifierCount() const

{

/** Gets the name of the method.

_checkRep();

@return CIMName with the name of the method.

return _rep->getQualifierCount();

Example:

}

<pre>

CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

Uint32 findParameter(const String& name) const

assert(m1.getName() == CIMName ("getHostName"));

{

</pre>

_checkRep();

return _rep->findParameter(name);

const CIMName& getName() const;

}

/** Gets the method return type.

CIMConstParameter getParameter(Uint32 pos) const

@return A CIMType containing the method return type.

{

@exception UninitializedObjectException Thrown if the object is not

_checkRep();

initialized.

return _rep->getParameter(pos);

Example:

}

<pre>

CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

Uint32 getParameterCount() const

assert(m1.getType() == CIMTYPE_STRING);

{

</pre>

_checkRep();

return _rep->getParameterCount();

CIMType getType() const;

}

/** Gets the class in which this method was defined. This information

operator int() const { return _rep != 0; }

is normally available with methods that are part of a schema

returned from a CIM Server.

void toXml(Array<Sint8>& out) const

@return CIMName containing the classOrigin attribute.

{

_checkRep();

const CIMName& getClassOrigin() const;

_rep->toXml(out);

}

/** Tests the propagated attribute of the object. The propagated

attribute indicates whether this method was propagated from a

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

higher-level class. Normally this attribute is set as part of

{

defining a method in the context of a schema. It is set in

_checkRep();

methods retrieved from a CIM Server.

_rep->print(o);

@return True if method is propagated; otherwise, false.

}

Boolean getPropagated() const;

Boolean identical(const CIMConstMethod& x) const

{

/** Searches for a qualifier with the specified input name.

x._checkRep();

@param name CIMName of the qualifier to be found.

_checkRep();

@return Zero origin index of the qualifier found or PEG_NOT_FOUND

return _rep->identical(x._rep);

if not found.

}

@exception UninitializedObjectException Thrown if the object is not

initialized.

Example:

<pre>

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

m1.addQualifier(CIMQualifier(CIMName ("stuff"), true));

CIMConstMethod m2(m1);

assert(m2.findQualifier(CIMName ("stuff")) != PEG_NOT_FOUND);

</pre>

Uint32 findQualifier(const CIMName& name) const;

/** Gets the CIMQualifier defined by the input parameter.

@param index Zero origin index of the qualifier requested.

@return CIMQualifier object representing the qualifier found.

@exception IndexOutOfBoundsException Thrown if the index is

outside the range of parameters available from the CIMMethod.

Example:

<pre>

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

m1.addQualifier(CIMQualifier(CIMName ("stuff"), true));

CIMConstMethod m2(m1);

Uint32 posQualifier = m2.findQualifier(CIMName ("stuff"));

if (posQualifier != PEG_NOT_FOUND)

{

CIMQualifier q = m2.getQualifier(posQualifier);

}

</pre>

CIMConstQualifier getQualifier(Uint32 index) const;

/** Returns the number of Qualifiers attached to this CIMConstMethod

object.

@return The number of qualifiers attached to the CIM method.

Example:

<pre>

CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

m1.addQualifier(CIMQualifier(CIMName ("stuff"), true));

m1.addQualifier(CIMQualifier(CIMName ("stuff2"), true));

CIMConstMethod m2(m1);

assert(m2.getQualifierCount() == 2);

</pre>

Uint32 getQualifierCount() const;

/** Finds the parameter with the specified name.

@param name CIMName of parameter to be found.

@return Index of the parameter object found or PEG_NOT_FOUND

if the property is not found.

Example:

<pre>

Uint32 posParameter;

posParameter = m1.findParameter(CIMName ("ipaddress"));

if (posParameter != PEG_NOT_FOUND)

...

</pre>

Uint32 findParameter(const CIMName& name) const;

/** Gets the parameter defined by the specified index.

@param index Index for the parameter to be returned.

@return CIMConstParameter object requested.

@exception IndexOutOfBoundsException Thrown if the index is outside

the range of available parameters.

Example:

<pre>

CIMConstParameter cp;

Uint32 parameterIndex = m1.findParameter(CIMName ("ipaddress"));

if (parameterIndex != PEG_NOT_FOUND)

{

cp = m1.getParameter(parameterIndex);

}

</pre>

CIMConstParameter getParameter(Uint32 index) const;

/** Gets the count of Parameters defined in the CIMMethod.

@return Count of the number of parameters attached to the CIMMethod.

Uint32 getParameterCount() const;

/** Determines if the object has not been initialized.

@return True if the object has not been initialized;

otherwise, false.

Example:

<pre>

CIMConstMethod m1;

assert(m1.isUninitialized());

</pre>

Boolean isUninitialized() const;

/** Compares with a CIMConstMethod.

@param x CIMConstMethod object for the method to be compared.

@return True if this method is identical to the one specified;

otherwise, false.

Example:

<pre>

CIMConstMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);

CIMConstMethod m2(CIMName ("test"), CIMTYPE_STRING);

assert(!m1.identical(m2));

</pre>

Boolean identical(const CIMConstMethod& x) const;

CIMMethod clone() const

/** Makes a clone (deep copy) of this CIMConstMethod. This creates

{

a new copy of all of the components of the method including

return CIMMethod(_rep->clone());

parameters and qualifiers.

}

@return Independent copy of the CIMConstMethod object. Note that

the copy is a non-constant CIMMethod.

CIMMethod clone() const;

private:

void _checkRep() const

void _checkRep() const;

{

if (!_rep)

ThrowUnitializedHandle();

}

CIMMethodRep* _rep;

friend class CIMMethod;

friend class CIMMethodRep;

friend class XmlWriter;

friend class MofWriter;

};

#define PEGASUS_ARRAY_T CIMMethod

# include "ArrayInter.h"

# include <Pegasus/Common/ArrayInter.h>

#undef PEGASUS_ARRAY_T

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.17.2.1
changed lines
	Added in v.1.49.2.1

No CVS admin address has been configured