All Frameworks Class Hierarchy This Framework Indexes Previous Next

DELLiveInfraU5Itf Interface DELILiveInfraBrowserAgent

Usage: you can freely reimplement this interface.

interface DELILiveInfraBrowserAgent

Interface used to display information in the immersive browser in Live Simulation.
Role: This interface offers methods to allow display of information in the immersive browser in Live Simulation.
The interface must be implemented on a dummy late-type composed from "DELLiveSimulation" + application specific string
Example: "DELLiveSimulation_CAAAgent"

Method Index

o GetBrowsers(CATPathElement*,CATUnicodeString&,CATUnicodeString&,int,void*): Method called when the set of browsers is initially created for a specific context object.
o GetCtxStatus(CATPathElement*,CATBoolean&)
o GetInfoBrowsers(CATListOfCATString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
o GetManagedEventsList(CATListOfCATUnicodeString&)
o GetPriority(int&)
o NotifyAgent(unsigned int)
o UpdateBrowsers(CATNotification*,CATUnicodeString&,CATUnicodeString&,int,CATBoolean&,void*)

Methods

o GetBrowsers

public virtual GetBrowsers(		`iPEContextObj`,
		`iWorkbenchName`,
		`iWorkshopName`,
		`iSettingsBitFlag`,
		`oBrowserDatas`)

Method called when the set of browsers is initially created for a specific context object. The agent should pass back a list of DELLiveInfraBrowserData objects. The context object should be used by the agent to determine which thumbnails should be displayed. One DELLiveInfraBrowserData object should be created per browser. The agent should cache the thumbnails it returns as well as the context object for use during the update phase.

Parameters:

iPEContextObj: [in] CATPathElement*. Path of the browser's context object. Use it as the starting point to determine which thumbnails to display in the browser.
iWorkbenchName: [in] CATUnicodeString&. Name of current workbench. Not valuated, do not use.
iWorkbenchShop: [in] CATUnicodeString&. Name of current workshop. Not valuated, do not use.
iSettingsBitFlag: [in] int. Settings bit flag. Currently always zero.
oBrowserDatas: [in/out] void*. A DELListOfDELLiveInfraBrowserData* cast as a void*. Passed in with a size of zero. Method should create and append one DELLiveInfraBrowserData structure for each browser they want displayed.

Returns:

S_OK on success, E_FAIL on failure

o GetCtxStatus

public virtual GetCtxStatus(		`iPEContextObj`,
		`oStatus`)

o GetInfoBrowsers

public virtual GetInfoBrowsers(		`oListBrwID`,
		`oListBrwName`,
		`oListBrwIcon`)

o GetManagedEventsList

public virtual GetManagedEventsList( olUCStr)

o GetPriority

public virtual GetPriority( oPriority)

o NotifyAgent

public virtual NotifyAgent( iEvent)

o UpdateBrowsers

public virtual UpdateBrowsers(		`iNotification`,
		`iWorkbenchName`,
		`iWorkshopName`,
		`iSettingsBitFlag`,
		`oChanges`,
		`oBrowserDatas`)

This object is included in the file: DELILiveInfraBrowserAgent.h
If needed, your Imakefile.mk should include the module: DELLiveInfraU5Itf