All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMInterferenceUseItf Interface PLMIInterferenceGroupObjects

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

interface PLMIInterferenceGroupObjects

Interface to manage the content of groups of an Interference Simulation.

To retrieve a pointer on interface PLMIInterferenceGroupObjects, see method .

Method Index

o Add(CATIPLMNavOccurrence*): Adds an occurrence in the group.
o AddPLMFilter(CATIAdpPLMIdentificator*,PLMIInterferenceSimulation*): Adds a PLM Filter to the group.
o GetOccurrences(CATListPtrCATIPLMNavOccurrence&): Gets the list of occurrences of a group of an Interference Simulation.
o GetPLMFilter(CATIAdpPLMIdentificator*&): Gets the PLM Filter of the group.
o Remove(CATIPLMNavOccurrence*): Removes an occurrence in the group.
o RemovePLMFilter(): Removes the PLM Filter to the group.
o SetOccurrences(CATListPtrCATIPLMNavOccurrence&): Sets a list of occurrences to a group of an Interference Simulation.

Methods

o Add

public virtual Add( iOcc)

Adds an occurrence in the group.

Parameters:

iOcc: [in] The occurrence to add.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

    The following example adds an occurrence to the current group.
      PLMIInterferenceGroupObjects   * piItfGroup = ... ;  // (retrieved from a PLMIInterferenceSimulation )
   CATIPLMNavOccurrence           * piOcc      = ... ;  // an occurrence
   
   HRESULT hr = piItfGroup->Add (piOcc) ;

o AddPLMFilter

public virtual AddPLMFilter(		`ipiAdpIdentFilter`,
		`ipiItfSimu`)

Adds a PLM Filter to the group.

Parameters:

ipiAdpIdentFilter: [in] The PLM Filter to add.
Use method
ipiItfSimu: [in] Simulation to which the group belongs.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.
E_INVALIDARG: If input arguments are not valid or if the Root Product filtered by the PLM Filter is not the same than the Root Product referenced by the simulation (see method .

Example:

    The following example adds a PLM Filter to the current group.
      PLMIInterferenceSimulation     * ipiItfSimu        = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceGroupObjects   * piItfGroup        = ... ;  // (retrieved from a PLMIInterferenceSimulation )
   CATIAdpPLMIdentificator        * piAdpIdentFilter  = ... ;  // one PLM Filter of the list returned by method RetrievePersistentFilterFromStructure
   
   HRESULT hr = piItfGroup->AddPLMFilter (piAdpIdentFilter, ipiItfSimu) ;

o GetOccurrences

public virtual GetOccurrences( oListOcc)

Gets the list of occurrences of a group of an Interference Simulation.

Parameters:

oListOcc: [out] The list of occurrences. The caller must release the elements of the list

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example gets the list of occurrences of a group.
      PLMIInterferenceGroupObjects   * piItfGroup = ... ;  // (Group retrieved from PLMIInterferenceSimulation )
   CATListPtrCATIPLMNavOccurrence   ListOcc ;  // the list of occurrences
   
   HRESULT hr = piItfGroup->GetOccurrences (ListOcc) ;

o GetPLMFilter

public virtual GetPLMFilter( opiAdpIdentFilter)

Gets the PLM Filter of the group.

Parameters:

opiAdpIdentFilter: [out, CATBaseUnknown#Release] The PLM Filter of the group.
A group can only contain one Product Filter (and only one) or selected node or parts.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

    The following example gets the PLM Filter of the current group.
      PLMIInterferenceGroupObjects   * piItfGroup        = ... ;  // (retrieved from a PLMIInterferenceSimulation )
   CATIAdpPLMIdentificator        * piAdpIdentFilter  = NULL ;
   
   HRESULT hr = piItfGroup->GetPLMFilter (piAdpIdentFilter) ;

o Remove

public virtual Remove( iOcc)

Removes an occurrence in the group.

Parameters:

iOcc: [in] The occurrence to remove.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

    The following example removes an occurrence to the current group.
      PLMIInterferenceGroupObjects   * piItfGroup = ... ;  // (retrieved from a PLMIInterferenceSimulation )
   CATIPLMNavOccurrence           * piOcc      = ... ;  // an occurrence
   
   HRESULT hr = piItfGroup->Remove (piOcc) ;

o RemovePLMFilter

public virtual RemovePLMFilter(

)

Removes the PLM Filter to the group.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

    The following example removes the PLM Filter of the current group.
      PLMIInterferenceGroupObjects   * piItfGroup        = ... ;  // (retrieved from a PLMIInterferenceSimulation )
   
   HRESULT hr = piItfGroup->RemovePLMFilter () ;

o SetOccurrences

public virtual SetOccurrences( iListOcc)

Sets a list of occurrences to a group of an Interference Simulation.

Parameters:

iListOcc: [in] The list of occurrences to set to the group. These occurrences replace occurrences already present in the group

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example sets a list of occurrences to the current group.
      PLMIInterferenceGroupObjects   * piItfGroup = ... ;  // (retrieved from a PLMIInterferenceSimulation )
   CATListPtrCATIPLMNavOccurrence   ListOcc    = ... ;  // the list of occurrences
   
   HRESULT hr = piItfGroup->SetOccurrences (ListOcc) ;

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