_CMPIBrokerEncFT Struct Reference

This structure is a table of pointers to broker and factory services of encapsulated CMPIObjects. More...

#include <cmpift.h>

Collaboration diagram for _CMPIBrokerEncFT:

Collaboration graph
[legend]
List of all members.

Public Attributes

int ftVersion
 Function table version.
CMPIInstance *(* newInstance )(const CMPIBroker *mb, const CMPIObjectPath *op, CMPIStatus *rc)
 Instance factory service.
CMPIObjectPath *(* newObjectPath )(const CMPIBroker *mb, const char *ns, const char *cn, CMPIStatus *rc)
 ObjectPath factory service.
CMPIArgs *(* newArgs )(const CMPIBroker *mb, CMPIStatus *rc)
 Args container factory service.
CMPIString *(* newString )(const CMPIBroker *mb, const char *data, CMPIStatus *rc)
 String container factory service.
CMPIArray *(* newArray )(const CMPIBroker *mb, CMPICount max, CMPIType type, CMPIStatus *rc)
 Array container factory service.
CMPIDateTime *(* newDateTime )(const CMPIBroker *mb, CMPIStatus *rc)
 DateTime factory service.
CMPIDateTime *(* newDateTimeFromBinary )(const CMPIBroker *mb, CMPIUint64 binTime, CMPIBoolean interval, CMPIStatus *rc)
 DateTime factory service.
CMPIDateTime *(* newDateTimeFromChars )(const CMPIBroker *mb, const char *utcTime, CMPIStatus *rc)
 DateTime factory service.
CMPISelectExp *(* newSelectExp )(const CMPIBroker *mb, const char *query, const char *lang, CMPIArray **projection, CMPIStatus *st)
 SelectExp factory service.
CMPIBoolean(* classPathIsA )(const CMPIBroker *mb, const CMPIObjectPath *op, const char *type, CMPIStatus *rc)
 Function to determine whether a CIM class is of <type> or any of <type> subclasses.
CMPIString *(* toString )(const CMPIBroker *mb, const void *object, CMPIStatus *rc)
 Attempts to transforms an CMPI object to a broker specific string format.
CMPIBoolean(* isOfType )(const CMPIBroker *mb, const void *object, const char *type, CMPIStatus *rc)
 Verifies whether <object> is of CMPI type <type>.
CMPIString *(* getType )(const CMPIBroker *mb, const void *object, CMPIStatus *rc)
 Retrieves the CMPI type of <object>.

Detailed Description

This structure is a table of pointers to broker and factory services of encapsulated CMPIObjects.

This table is made available by the Management Broker, aka CIMOM, whenever a provider is loaded and initialized.

Definition at line 48 of file cmpift.h.

Member Data Documentation

CMPIBoolean(* _CMPIBrokerEncFT::classPathIsA)(const CMPIBroker *mb, const CMPIObjectPath *op, const char *type, CMPIStatus *rc)
 

Function to determine whether a CIM class is of <type> or any of <type> subclasses.

Parameters:
mb Broker this pointer
op The class path (namespace and classname components).
type The type to tested for.
rc Output: Service return status (suppressed when NULL).
Returns:
True if test successful.

Referenced by CmpiObjectPath::doClassPathIsA().

int _CMPIBrokerEncFT::ftVersion
 

Function table version.

Definition at line 52 of file cmpift.h.

CMPIString*(* _CMPIBrokerEncFT::getType)(const CMPIBroker *mb, const void *object, CMPIStatus *rc)
 

Retrieves the CMPI type of <object>.

Intended for debugging purposes only.

Parameters:
mb Broker this pointer
object A valid CMPI object.
rc Output: Service return status (suppressed when NULL).
Returns:
CMPI object type.

CMPIBoolean(* _CMPIBrokerEncFT::isOfType)(const CMPIBroker *mb, const void *object, const char *type, CMPIStatus *rc)
 

Verifies whether <object> is of CMPI type <type>.

Intended for debugging purposes only.

Parameters:
mb Broker this pointer
object A valid CMPI object.
type A string specifying a valid CMPI Object type ("CMPIInstance", "CMPIObjectPath", etc).
rc Output: Service return status (suppressed when NULL).
Returns:
True if test successful.

Referenced by CmpiObject::doIsA().

CMPIArgs*(* _CMPIBrokerEncFT::newArgs)(const CMPIBroker *mb, CMPIStatus *rc)
 

Args container factory service.

Parameters:
mb Broker this pointer
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created Args container.

Referenced by CmpiArgs::makeArgs().

CMPIArray*(* _CMPIBrokerEncFT::newArray)(const CMPIBroker *mb, CMPICount max, CMPIType type, CMPIStatus *rc)
 

Array container factory service.

Parameters:
mb Broker this pointer
max Maximum number of elements
type Element type
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created Array.

Referenced by CmpiArray::makeArray().

CMPIDateTime*(* _CMPIBrokerEncFT::newDateTime)(const CMPIBroker *mb, CMPIStatus *rc)
 

DateTime factory service.

Initialized with the time of day.

Parameters:
mb Broker this pointer
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created DateTime.

Referenced by CmpiDateTime::makeDateTime().

CMPIDateTime*(* _CMPIBrokerEncFT::newDateTimeFromBinary)(const CMPIBroker *mb, CMPIUint64 binTime, CMPIBoolean interval, CMPIStatus *rc)
 

DateTime factory service.

Initialized from <binTime>.

Parameters:
mb Broker this pointer
binTime Date/Time definition in binary format in microsecods starting since 00:00:00 GMT, Jan 1,1970.
interval Wenn true, defines Date/Time definition to be an interval value
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created DateTime.

Referenced by CmpiDateTime::makeDateTime().

CMPIDateTime*(* _CMPIBrokerEncFT::newDateTimeFromChars)(const CMPIBroker *mb, const char *utcTime, CMPIStatus *rc)
 

DateTime factory service.

Is initialized from <utcTime>.

Parameters:
mb Broker this pointer
utcTime Date/Time definition in UTC format
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created DateTime.

Referenced by CmpiDateTime::makeDateTime().

CMPIInstance*(* _CMPIBrokerEncFT::newInstance)(const CMPIBroker *mb, const CMPIObjectPath *op, CMPIStatus *rc)
 

Instance factory service.

Parameters:
mb Broker this pointer
op ObjectPath containing namespace and classname.
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created Instance.

Referenced by CmpiInstance::makeInstance().

CMPIObjectPath*(* _CMPIBrokerEncFT::newObjectPath)(const CMPIBroker *mb, const char *ns, const char *cn, CMPIStatus *rc)
 

ObjectPath factory service.

Parameters:
mb Broker this pointer
ns Namespace
cn Classname.
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created ObjectPath.

Referenced by CmpiObjectPath::makeObjectPath().

CMPISelectExp*(* _CMPIBrokerEncFT::newSelectExp)(const CMPIBroker *mb, const char *query, const char *lang, CMPIArray **projection, CMPIStatus *st)
 

SelectExp factory service.

TBD.

Parameters:
mb Broker this pointer
query The select expression.
lang The query language.
projection Output: Projection specification (suppressed when NULL).
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created SelectExp.

CMPIString*(* _CMPIBrokerEncFT::newString)(const CMPIBroker *mb, const char *data, CMPIStatus *rc)
 

String container factory service.

Parameters:
mb Broker this pointer
data String data
rc Output: Service return status (suppressed when NULL).
Returns:
The newly created String.

Referenced by mbEncGetType().

CMPIString*(* _CMPIBrokerEncFT::toString)(const CMPIBroker *mb, const void *object, CMPIStatus *rc)
 

Attempts to transforms an CMPI object to a broker specific string format.

Intended for debugging purposes only.

Parameters:
mb Broker this pointer
object A valid CMPI object.
rc Output: Service return status (suppressed when NULL).
Returns:
String from representation of <object>.

Referenced by CmpiObject::doToString().

The documentation for this struct was generated from the following file:
Generated on Thu Feb 9 09:11:28 2006 for openwbem by  doxygen 1.4.6