All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseMultiSelManager

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

interface CATIGSMUseMultiSelManager

Interface required on component manager for multiselection in GSD UI.

Role :

Allows to handle GSD MultiSelection at creation or edition transactions

 
   //1- How to retrieve the interface ; 
   //------------------------------------------------------------------------------------
   #include "CATGSMCreateMultiSelManager.h" //  Define the component managing MultiSelection 
   #include "CATIGSMUseMultiSelManager.h"         //  Interface implemented by the component
  .... 
   
    HRESULT rc = S_OK;
    CATIGSMUseMultiSelManager *piMSMgr = NULL; 
    rc = CATGSMCreateMultiSelManager ( *&piMSMgr);
   
   if (SUCCEEDED(rc) && NULL != piMSMgr) {
                  ...... 
      }

Method Index

o CheckMultiSelCoherency(CATBaseUnknown_var,CATIEdit_var&,CATIMmiMechanicalFeature_var&): Check the MultiOutput Coherency.
o ConvertVirtFeatsToRealFeats(CATLISTV(CATIMmiMechanicalFeature_var)&,CATLISTV(CATIMmiMechanicalFeature_var)&): Changes the state of the multisel features during multisel transaction.
o Declare(CATIMmiMechanicalFeature_var&): Asks to the multisel feature to instanciate the multisel feature with a new Input.
o Declare(CATIMmiMechanicalFeature_var&,int): Asks to the multisel feature to instanciate the multisel feature with a new Input at indice nB.
o DestroyRealFeatsEntries(CATLISTV(CATIMmiMechanicalFeature_var)&): Delete the state of multisel features that it has been removed during multisel transaction
Some feature previously instanciated do not correspond to a valid multisel results, then need to be removed
WARNING : dead features need to be remove immediately after (info in temporary structure is cleaned)
o DuplicateObjectsMS(CATIMmiMechanicalFeature_var,CATLISTV(CATIMmiMechanicalFeature_var)&,CATLISTV(CATIMmiMechanicalFeature_var)&): Duplicate features under multisel.
o GetImpactedFeatures(CATLISTV(CATIMmiMechanicalFeature_var)&,CATLISTV(CATIMmiMechanicalFeature_var)&,CATLISTV(CATIMmiMechanicalFeature_var)&): Gets the state of MultiSel for pre-visualisation (for two multiSel input).
o GetMSList(CATLISTV(CATIMmiMechanicalFeature_var)&,int): Gets the Multisel Inputs List at index iNb (iNb =1 or 2).
o GetRealFeaturesList(CATLISTV(CATIMmiMechanicalFeature_var)&): Gets list of all real multisel features.
o ImpactAll(void): Asks to the multisel feature to consider that all input are impacted by a modification
o InitializeMS(CATIGSMUseFactory_var,CATIMmiMechanicalFeature_var,CATIMmiMechanicalFeature_var,CATIMmiMechanicalFeature_var&): Initialize MultiSel for creation or edit.
o InstanciateObjectMS(CATIMmiMechanicalFeature_var): Instanciate MS at computing.
o Remove(CATIMmiMechanicalFeature_var&,int): Asks to the multisel feature to remove an input ( nB = num of the input).
o RemoveAll(int): Asks to the multisel feature to remove all input specs ( nB = num of the input).
o Replace(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,int): Asks to the multisel feature to replace an input ( nB = num of the input).
o ValidateMS(): Validate MultiSel , finalized all interactive actions related multisel
o ValidateManipulations(CATRawCollint*,CATRawCollint*): Validates the states the multisel feature during multisel transaction after duplication or Instanciation.

Methods

o CheckMultiSelCoherency

public virtual CheckMultiSelCoherency(	const	`EditedSpec`,
		`spIEdit`,
		`spSpec`)

Check the MultiOutput Coherency.
Used in the implementation of CATIEdit.

Parameters:

EditSpec: Spec to edit
spEdit: Interface on CATIEdit
spSpec: Spec object

o ConvertVirtFeatsToRealFeats

public virtual ConvertVirtFeatsToRealFeats(		`oList1`,
		`oList2`)

Changes the state of the multisel features during multisel transaction.
Asks internally to the multisel object to consider that virtual feature results (not already instanciate) become reals (instanciated)
WARNING Instanciation needs to be done immmediatly after (state in temporary structure is updated)

Parameters:

oList1: Number of declare input that are tagged as Virtual for multisel input 1
oList2: Number of declare input that are tagged as Virtual for multisel input 2

See also:

o Declare

public virtual Declare( iSpec)

Asks to the multisel feature to instanciate the multisel feature with a new Input.
[Use with single input multisel]

Parameters:

iSpec: New multisel input

o Declare

public virtual Declare(		`iSpec`,
		`nB`)

Asks to the multisel feature to instanciate the multisel feature with a new Input at indice nB.
[Use with double input multisel]
Note: Only 2 (nB <=2 ) differents inputs are handle yet

Parameters:

iSpec: New multisel input
inB: number of the multisel input ( 1 or 2)

o DestroyRealFeatsEntries

public virtual DestroyRealFeatsEntries( oListOfDeadRealFeats)

Delete the state of multisel features that it has been removed during multisel transaction
Some feature previously instanciated do not correspond to a valid multisel results, then need to be removed
WARNING : dead features need to be remove immediately after (info in temporary structure is cleaned)

Parameters:

oListOfDeadRealFeats: List of "dead" features

o DuplicateObjectsMS

public virtual DuplicateObjectsMS(		`ispSpecMatrix`,
		`iList1`,
		`iList2`)

Duplicate features under multisel.

Parameters:

ispMultiSel: MultiSel object
ispSpecMatrix: Template for instanciate objects
iList1: List of multisel features, first multisel input
iList2: List of multisel features, second multisel input

o GetImpactedFeatures

public virtual GetImpactedFeatures(		`oRealFeats`,
		`oListVirtual1`,
		`oListVirtual2`)

Gets the state of MultiSel for pre-visualisation (for two multiSel input).

Parameters:

oRealFeats: List of already instanciated feature (need just to be updae)
oListVirtual1: List of multisel input virtual for multisel Input 1 , No feature result (real) yet.
oListVirtual2: List of multisel input virtual for multisel Input 2 , No feature result (real) yet.

o GetMSList

public virtual GetMSList(		`oList`,
		`nB`	`=1`)

Gets the Multisel Inputs List at index iNb (iNb =1 or 2).
To be used in multiSel Manager CATIGSMUsemultiSelManager with DuplicateObjectsMS method

Parameters:

oSize: Number of declare input featured
iNb: number of the multisel input considered ( 1 or 2)

o GetRealFeaturesList

public virtual GetRealFeaturesList( oRealFeats)

Gets list of all real multisel features.
use in GetResult / GetRealFeaturesList

Parameters:

oRealFeats: List of real features

o ImpactAll

public virtual ImpactAll( )

Asks to the multisel feature to consider that all input are impacted by a modification

o InitializeMS

public virtual InitializeMS(		`ispFact`,
		`ispSpecOnMS`,
		`ispMatrixFeature`,
		`ospMultiSel`)

Initialize MultiSel for creation or edit.
case 1 - iSpecOnMS = NULL_var => Creation of MultiSel with the Factory
case 2 - iSpecOnMS != NULL_var => Case MonoSel ,only Initialisation of MultiSel Mode in Edit Mode

Parameters:

ispFact: Factory Shape Design
ispSpecOnMS: Init MS from a current instance of a multisel object
ispMatrixFeature: Matrix feature created before the MultiSel feature
ospMultiSel: MultiSel object (private geometrical Set) initialized or re-initialized

o InstanciateObjectMS

public virtual InstanciateObjectMS( SpecMatrix)

Instanciate MS at computing.
perform duplication from Spec matrix, encapsulate DuplicateObjectsMS en query to list of inputs in

Parameters:

ispMultiSel: MultiSel object
ispSpecMatrix: Template for instanciate objects

o Remove

public virtual Remove(		`iSpec`,
		`nB`	`= 1`)

Asks to the multisel feature to remove an input ( nB = num of the input).
Ex : Spec input is remove, one instance of the feature in multisel is removed *
[single/double input multisel]

Parameters:

iSpec: multisel input to remove
inB: number of the multisel input ( 1 or 2)

o RemoveAll

public virtual RemoveAll( nB =1)

Asks to the multisel feature to remove all input specs ( nB = num of the input).

Parameters:

inB: number of the multisel input ( 1 or 2)

o Replace

public virtual Replace(	`iSpecInit`,
	`iSpecNew`,
	`nB`	`= 1`)

Asks to the multisel feature to replace an input ( nB = num of the input).
Ex : SpecNew is replace by SpecInit in Nb input field
[single/double input multisel]

Parameters:

iSpecInit: multisel input to be replace
iSpecNew: multisel input new
inB: number of the multisel input ( 1 or 2)

o ValidateMS

public virtual ValidateMS(

)

Validate MultiSel , finalized all interactive actions related multisel

Parameters:

ispMultiSel: MultiSel object (private geometrical Set) validation :
Check and terminate Multiselection transaction

o ValidateManipulations

public virtual ValidateManipulations(		`newIndices`,
		`newStates`)

Validates the states the multisel feature during multisel transaction after duplication or Instanciation.
Verify internally impact of MultiSel inputs on multisel result features (Update/State)

Parameters:

oNewIndices: oNewIndices
oNewStates: oNewStates

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