All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DMAPSInterfaces Interface CATISPPResourceManagement

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISPPResourceManagement
 

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


interface CATISPPResourceManagement

Interface to manage the association of Resources to Activity Specifications.


Method Index


o AddResource(CATBaseUnknown_var,CATSPPResourceLinkType,CATBoolean)
Adds a resource to an activity.
o GetNumberOfResources(CATSPPResourceLinkType)
Returns the number of Resources Assigned to an Activity.
o GetPrcsResourceRelationObject(CATBaseUnknown_var&,CATISPPResourceManagement::CATSPPResourceLinkType,CATListValCATBaseUnknown_var*&)
Retrieves the list of process-resource relation objects for a given resource and a given assignment type.
o GetPrcsResourceRelations(CATListValCATBaseUnknown_var*&)
Retrieves the list of process-resource relation objects.
o GetResources(CATUnicodeString&,CATSPPResourceLinkType)
Returns a list of Resource Assigned to an Activity.
o HasResourceAssigned(CATBaseUnknown*,CATSPPResourceLinkType)
Determines whether a resource is assigned on the activity.
o RemoveResource(CATBaseUnknown_var,CATSPPResourceLinkType)
Removes an Assignement to a specific Resource.
o SubActivitiesForResource(CATBaseUnknown*,CATListValCATBaseUnknown_var*,CATSPPResourceLinkType)
Lists all sub-activities which have a given resource assigned.

Enumerated Type Index


o CATSPPResourceLinkType

Methods


o AddResource
public virtual HRESULT AddResource(CATBaseUnknown_var iResource,
const CATSPPResourceLinkType iLinkType= process_uses_resource,
CATBoolean iCheckLink= TRUE )= 0
Adds a resource to an activity.
Role: Creates an Assignement to a specific Ressource.
Parameters:
iResource
Handler on the Resource Interface to be added to this Activity.
iType
enum to specify the type of the link that needs to be created
iCheckLink
flag to enable/disable check for cyclic assignments. This is applicable only for TSAs(processes) belonging to a resource. If TRUE, user cannot assign a owning resource (and/or its entire parent hierarchy) to any TSAs underneath its Behavior(process) structure.
o GetNumberOfResources
public virtual int GetNumberOfResources( const CATSPPResourceLinkType iLinkType= any_resource_kind) = 0
Returns the number of Resources Assigned to an Activity.
Parameters:
iType
type of the Resource to be searched for
o GetPrcsResourceRelationObject
public virtual HRESULT GetPrcsResourceRelationObject( const CATBaseUnknown_var& iResource,
CATISPPResourceManagement::CATSPPResourceLinkType iLinkType,
CATListValCATBaseUnknown_var*& oActRsRqList)= 0
Retrieves the list of process-resource relation objects for a given resource and a given assignment type.
Parameters:
iResource
input parameter: the resource for which we want the process-resource relation object(s). If not specified (NULL_var), the method will consider all resources assigned to this activity.
iLinkType
input parameter: the assignment type to be considered. If negative, the method will consider all resource assignment types for this activity.
oActRsRqList
output parameter: NULL or found process-resource relation objects list
Returns:
HRESULT Error code of function. Possible values: E_FAIL = something went wrong (null pointer ...). S_FALSE = we found no process-resource relation objects(oActRsRqList MAY BE NULL). S_OK = we found at least one process-resource relation object.
o GetPrcsResourceRelations
public virtual HRESULT GetPrcsResourceRelations(CATListValCATBaseUnknown_var*& oActRsRqList)= 0
Retrieves the list of process-resource relation objects.
Parameters:
oActRsRqList
output parameter: NULL or found process-resource relation objects list.
Returns:
HRESULT Error code of function. Possible values: E_FAIL = something went wrong (null pointer ...). S_FALSE = we found no process-resource relation objects(oActRsRqList MAY BE NULL). S_OK = we found at least one process-resource relation object.
o GetResources
public virtual CATListValCATBaseUnknown_var * GetResources( const CATUnicodeString& type= "Resource",
const CATSPPResourceLinkType iLinkType= any_resource_kind) = 0
Returns a list of Resource Assigned to an Activity.
Parameters:
iType
type of the Resource to be searched for
Returns:
List of Handlers on Resources Assigned to the Activity
o HasResourceAssigned
public virtual HRESULT HasResourceAssigned( const CATBaseUnknown* iResource,
const CATSPPResourceLinkType iLinkType= any_resource_kind) = 0
Determines whether a resource is assigned on the activity.
Parameters:
iResource
concerned resource.
iType
type of the Resource to be searched for
o RemoveResource
public virtual void RemoveResource( const CATBaseUnknown_var iResource,
const CATSPPResourceLinkType iLinkType= process_uses_resource) = 0
Removes an Assignement to a specific Resource.
Parameters:
iResource
Handler on the Resource Interface to be removed to this Activity
iType
type of the Resource to be searched for
o SubActivitiesForResource
public virtual HRESULT SubActivitiesForResource( const CATBaseUnknown* iResource,
CATListValCATBaseUnknown_var* oListOfSubActivities,
const CATSPPResourceLinkType iLinkType= any_resource_kind) = 0
Lists all sub-activities which have a given resource assigned.
Parameters:
iResource
concerned resource.
oListOfSubActivities
list of concerned sub-activities.
iType
type of the Resource to be searched for

Enumerated Types


o CATSPPResourceLinkType
enum CATSPPResourceLinkType {
  any_resource_kind,
  process_uses_resource,
  process_running_on_resource,
  process_manages_resource_viewpoint,
  process_manages_resource_visualization
}

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

Copyright © 2003, Dassault Systèmes. All rights reserved.