All Classes Functions Variables Properties
List of all members | Public Member Functions | Properties
ICWFGM_LayerManager Class Reference

Interface ICWFGM LayerManager. More...

import "GridCOM.idl";

Collaboration diagram for ICWFGM_LayerManager:
Collaboration graph

Public Member Functions

HRESULT NewLayerThread ([out, retval] __int64 *layerThread)
 
HRESULT DeleteLayerThread ([in] __int64 layerThread)
 
HRESULT GetGridEngine ([in] __int64 layerThread, [in] ICWFGM_GridEngine *key, [out] ULONG **cnt, [out, retval] ICWFGM_GridEngine **pVal)
 
HRESULT PutGridEngine ([in] __int64 layerThread, [in] ICWFGM_GridEngine *key, [in] ICWFGM_GridEngine *layer)
 

Properties

VARIANT UserData [get, set]
 

Detailed Description

Interface ICWFGM LayerManager.

Objects inheriting from ICWFGM_GridEngine can be layered and stacked according to the design of a given scenario. However, the ICWFGM_Scenario object does not manage this layering. This object manages the layering for each ICWFGM_GridEngine object to use. layerThreads can be assigned to multiple scenarios, and can be left unused until they are needed.

Member Function Documentation

ICWFGM_LayerManager::DeleteLayerThread ( [in] __int64  layerThread)

Frees a layerThread object which was created from NewLayerThread.

Parameters
layerThreadA previously allocated "thread" which is no longer needed.
ICWFGM_LayerManager::GetGridEngine ( [in] __int64  layerThread,
[in] ICWFGM_GridEngine key,
[out] ULONG **  cnt,
[out, retval] ICWFGM_GridEngine **  pVal 
)

Given a layerThread, and an object (key), returns the next-lower ICWFGM_GridEngine object in the stack.

Parameters
layerThreadAllocated from NewLayerThread
keyThe ICWFGM_GridEngine object which wishes to obtain the next-lower ICWFGM_GridEngine object in the stack.
cntPointer to an unused ULONG, which can be used by the client 'key' object. This value is initialized to 0, and must be set to 0 before clean-up.
pValThe ICWFGM_GridEngine object which is the next-lower object from the requestor.
ICWFGM_LayerManager::NewLayerThread ( [out,retval] __int64 *  layerThread)

Allocates a new layerThread for purposes of recording a sequence of stacking ICWFGM_GridEngines for a given scenario or scenarios.

Parameters
layerThreadNewly allocated "thread" to record how various ICWFGM_GridEngine objects are stacked.
ICWFGM_LayerManager::PutGridEngine ( [in] __int64  layerThread,
[in] ICWFGM_GridEngine key,
[in] ICWFGM_GridEngine layer 
)

Given a layerThread, and an object (key), stores/records the next-lower ICWFGM_GridENgine object in the stack.

Parameters
layerThreadAllocated from NewLayerThread
keyThe ICWFGM_GridEngine object which wishes to obtain the next-lower ICWFGM_GridEngine object in the stack.
layerThe ICWFGM_GridEngine object which is the next-lower object from the requestor. If this value is NULL, then clean-up may occur.

Property Documentation

Property ICWFGM_LayerManager::UserData
getsetproperty

This property is unused by this object, and is available for exclusive use by the client code. It is a VARIANT value to ensure that the client code can store a pointer value (if it chooses) for use in manual subclassing this object. This value is not loaded or saved during serialization operations, and it is the responsibility of the client code to manage any value or object stored here. Access to this property is not thread-safe.

Parameters
pValvalue of UserData
newValreplacement value for UserData