All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DMAPSInterfaces Interface CATISPPItemMgt

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

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


interface CATISPPItemMgt

Interface to manage the association of Items as Parts, Welds, etc with Activity Specifications.


Method Index


o AddActivitySpecification(CATICkeParm_var&,CATISPPItem_var&,CATISPPProductIO_var&,CATUnicodeString&,int,CATSPPAssignmentType)
Creates a specification for an Activity to work on a specific item.
o AddItem(CATBaseUnknown_var&)
Creates a specification for an Activity to work on a specific item.
o AddItem(CATBaseUnknown_var&,int,CATSPPAssignmentType)
Creates a specification for an Activity to work on a specific item.
o AddMultipleActSpecs(CATICkeParm_var&,CATListValCATBaseUnknown_var&,CATListValCATBaseUnknown_var&,CATUnicodeString&,int,CATSPPAssignmentType,CATListOfInt*)
Creates a list of specifications for an Activity to work on a list of corresponding items.
o AddMultipleItems(CATListValCATBaseUnknown_var&,int,CATSPPAssignmentType,CATListOfInt*)
Creates a list of specifications for an Activity to work on a list of corresponding items.
o CreateActivitySpecification(CATICkeParm_var&,CATISPPItem_var&,CATISPPProductIO_var&,CATUnicodeString&,int,CATSPPAssignmentType,int)
Creates a specification for an Activity to work on a specific item, and returns the created activity specification
o GetActivitySpecification(CATISPPItem_var&,CATISPPProductIO_var&,CATSPPAssignmentType)
o GetItems(CATUnicodeString&,CATSPPAssignmentType)
Returns a list of Activity Specifications working on a specific type of Items.
o GetNumberOfItems(CATSPPAssignmentType)
Returns the number of Items (in fact the number of Specifications) on an Activity.
o HasItemAssigned(CATISPPItem*,CATSPPAssignmentType)
Determines whether an item is assigned on the activity.
o RemoveItem(CATBaseUnknown_var&,CATSPPAssignmentType)
Removes the Specifications of an Activity, which were working on a specific Item.
o RemoveMultipleActSpecs(CATListValCATBaseUnknown_var&)
Removes the list of specified Specifications of an Activity.
o RemoveMultipleItems(CATListValCATBaseUnknown_var&,CATSPPAssignmentType)
Removes the Specifications of an Activity, which were assigned to work on a list of specific Items.
o SubActivitiesForItem(CATISPPItem*,CATListValCATBaseUnknown_var*,CATSPPAssignmentType)
Lists all sub-activities which have a given item assigned.

Enumerated Type Index


o CATSPPAssignmentType

Methods


o AddActivitySpecification
public virtual void AddActivitySpecification( const CATICkeParm_var& iTargetState,
const CATISPPItem_var& iItem,
const CATISPPProductIO_var& iProductInput,
const CATUnicodeString& iItemType,
const int iUpdate,
const CATSPPAssignmentType iType= processes) = 0
Creates a specification for an Activity to work on a specific item.
Parameters:
iTargetState
Handler to CATICkeParm
iItem
Handler to the item to be assigned
iProductInput
Product Input created for the item
iItemType
iUpdate
iType
o AddItem
public virtual CATBaseUnknown_var AddItem( const CATBaseUnknown_var& item)= 0
Creates a specification for an Activity to work on a specific item.
Parameters:
item
Handler on the Item Interface to be added to the new Activity
Returns:
Handler on the the newly created Activity Specification Interface.
o AddItem
public virtual CATBaseUnknown_var AddItem( const CATBaseUnknown_var& item,
const int iUpdate,
const CATSPPAssignmentType iType= processes) = 0
Creates a specification for an Activity to work on a specific item.
Parameters:
item
Handler on the Item Interface to be added to the new Activity
iUpdate
Determines if assigned item can be updated or not.
iType
Determines the type of the Assignment
Returns:
Handler on the the newly created Activity Specification Interface.
o AddMultipleActSpecs
public virtual CATListValCATBaseUnknown_var AddMultipleActSpecs( const CATICkeParm_var& iTargetState,
const CATListValCATBaseUnknown_var& iLItems,
const CATListValCATBaseUnknown_var& iLProductInput,
const CATUnicodeString& iItemType,
const int iUpdate= 0,
const CATSPPAssignmentType iOneType= processes,
const CATListOfInt* iLAssignmentTypes= NULL) = 0
Creates a list of specifications for an Activity to work on a list of corresponding items.
Parameters:
iTargetState
handle to CATICkeParm
iLItems
list of handles to the items to be assigned
iLProductInput
list of Product Input created for the items
iItemType
the Item type string
iUpdate
0 or 1 ( Default value:0 used for all item assignments )- Used to support product flow
iOneType
If the following parameter is NULL or its size not equal to that of the first parameter, then this is the type of the Assignment, which is always "processes" if default
iLAssignmentType
If it is not NULL and its size equals to that of the first parameter, then this determines the types of the Assignments
Returns:
The list of handles to the newly created Activity Specifications.
o AddMultipleItems
public virtual CATListValCATBaseUnknown_var AddMultipleItems( const CATListValCATBaseUnknown_var& iLItems,
const int iUpdate= 0,
const CATSPPAssignmentType iOneType= processes,
const CATListOfInt* iLAssignmentTypes= NULL) = 0
Creates a list of specifications for an Activity to work on a list of corresponding items.
Parameters:
iLItems
The list of handles to items to be added to the new Activity
iUpdate
Determines if assigned items can be updated or not.
iOneType
If the following parameter is NULL or its size not equal to that of the first parameter, then this is the type of the Assignment, which is always "processes" if default
iLAssignmentType
If it is not NULL and its size equals to that of the first parameter, then this determines the types of the Assignments
Returns:
The list of handles to the newly created Activity Specifications.
o CreateActivitySpecification
public virtual CATBaseUnknown_var CreateActivitySpecification( const CATICkeParm_var& iTargetState,
const CATISPPItem_var& iItem= NULL_var,
const CATISPPProductIO_var& iProductInput= NULL_var,
const CATUnicodeString& iItemType= NULL_string,
const int iUpdate= 0,
const CATSPPAssignmentType iType= processes,
int withNotif= 1) = 0
Creates a specification for an Activity to work on a specific item, and returns the created activity specification
Parameters:
iTargetState
Handle to CATICkeParm
iItem
Handle to the item to be assigned
iProductInput
Product Input created for the item
iItemType
Item type string
iUpdate
0 or 1 ( Default value:0 used for all item assignments )- Used to support product flow
iType
Assignment type
withNotif
If 1, a notification will be sent, at the end of the creation, to propogate the activity's modify event. If 0, it will not be sent.
Returns:
Handle on the the newly created Activity Specification Interface.
o GetActivitySpecification
public virtual CATListValCATBaseUnknown_var GetActivitySpecification( const CATISPPItem_var& iItem= NULL_var,
const CATISPPProductIO_var& iProductInput= NULL_var,
const CATSPPAssignmentType iAssignmentType= all_item_kinds) = 0
o GetItems
public virtual CATListValCATBaseUnknown_var * GetItems( const CATUnicodeString& type= "Item",
const CATSPPAssignmentType AssignmentMode= default_item_kinds) = 0
Returns a list of Activity Specifications working on a specific type of Items.
Parameters:
type
type of the items to be searched in the Specifications of the Activities
AssignmentMode
AssignmentMode used to Assign the Item
Returns:
List of Handlers on Specifications of the Activity
o GetNumberOfItems
public virtual int GetNumberOfItems( const CATSPPAssignmentType iType= default_item_kinds) = 0
Returns the number of Items (in fact the number of Specifications) on an Activity.
Parameters:
iType
Determines the type of the Assignment
o HasItemAssigned
public virtual HRESULT HasItemAssigned( const CATISPPItem* iItem,
const CATSPPAssignmentType iType= processes) = 0
Determines whether an item is assigned on the activity.
Parameters:
iItem
concerned item.
iType
Determines the type of the Assignment
o RemoveItem
public virtual int RemoveItem( const CATBaseUnknown_var& item,
const CATSPPAssignmentType iType= all_item_kinds) = 0
Removes the Specifications of an Activity, which were working on a specific Item.
Parameters:
iItem
Handler on the Item Interface to be removed from the Activity Specifications
iType
Determines the type of the Assignment
Returns:
Warning: returns 0 if succeded only since CXR3SP4 ( before, returns 1 when succeded ).
o RemoveMultipleActSpecs
public virtual int RemoveMultipleActSpecs( const CATListValCATBaseUnknown_var& iLActivitySpecs) = 0
Removes the list of specified Specifications of an Activity.
Parameters:
iLActivitySpecs
The list of handles to the activity specifications to be removed from the activity
o RemoveMultipleItems
public virtual int RemoveMultipleItems( const CATListValCATBaseUnknown_var& iLItems,
const CATSPPAssignmentType iType= all_item_kinds) = 0
Removes the Specifications of an Activity, which were assigned to work on a list of specific Items.
Parameters:
iLItems
The list of handles to the items to be removed from the Activity Specifications
iType
Determines the type of the Assignment, which will be "processes" if NULL
Returns:
returns 1 if succeeded
o SubActivitiesForItem
public virtual HRESULT SubActivitiesForItem( const CATISPPItem* iItem,
CATListValCATBaseUnknown_var* oListOfSubActivities,
const CATSPPAssignmentType iType= processes) = 0
Lists all sub-activities which have a given item assigned.
Parameters:
iItem
concerned item.
oListOfSubActivities
list of concerned sub-activities.
iType
Determines the type of the Assignment

Enumerated Types


o CATSPPAssignmentType
enum CATSPPAssignmentType {
  default_item_kinds,
  processes,
  firstprocesses,
  removes,
  attachesresource,
  detachesresource,
  partiallyconsumes,
  completelyconsumes,
  productviewpoint,
  productvisualization,
  all_item_kinds
}

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

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