CAADELResourceModelAsIsItf Interface DELIPLMRMNavigation

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface DELIPLMRMNavigation

Interface to navigate on a Resource Structure.
Role: allows you to list child resources filtered on the type of resource.

Method Index


o GetSubResources(CATListValCATBaseUnknown_var&,DELIPLMRMNavigation::MAINTYPE*,CATUnicodeString*)
Retrieves instances of resources aggregated by the current resource reference.

Enumerated Type Index


o MAINTYPE
Enumerate value that defines the available values of Main Type of Resource.

Methods


o GetSubResources
public virtual HRESULT GetSubResources(CATListValCATBaseUnknown_var& oListe,
const DELIPLMRMNavigation::MAINTYPE* iMainType= NULL,
const CATUnicodeString* iSubType= NULL)=0
Retrieves instances of resources aggregated by the current resource reference.
Parameters:
oSubResources
The list of sub-resources
iMainType
The pointer on the main type value Legal values:
  • NULL : No filter on main type value.
  • !=NULL : Returns only the sub-resources corresponding to the given main type.
iSubType
The pointer on the sub type value Legal values:
  • NULL : No filter on sub type value.
  • !=NULL : Returns only the sub-resources corresponding to the given sub type.
Returns:
Legal values:
  • S_OK : List of sub-resources was correctly retrieved.
  • E_FAIL : An error has occured.

Enumerated Types


o MAINTYPE 
enum MAINTYPE {
  Organizational,
  Robot,
  Worker,
  NCMachine,
  Inspect,
  ToolDevice,
  Storage,
  Transport,
  Conveyor,
  ControlDevice,
  UserDefined,
  LogicController,
  Sensor,
  IndustrialMachine,
  Area,
  ManufacturingSetup,
  Pathway,
  UNREACHABLE_VALUE_MAINTYPE
}
Enumerate value that defines the available values of Main Type of Resource.
This object is included in the file: DELIPLMRMNavigation.h
If needed, your Imakefile.mk should include the module: CAADELResourceModelAsIsItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.