CATImmVPMInterfacesExt CATPLMNavPropertiesAcquisition

Usage: you must use this class as is. You should never derive it.

public class CATPLMNavPropertiesAcquisition

Class which provides a dialog acquisition agent to manage selection of a PLM entity in an editor.
Role: This dialog agent enables you to select objects in the immersive windows (Search result windows or Explore windows). It offers PLM compliant filtering of the selected object. This acquisition agent can be used in any customer command which needs to acquire properties of a PLM entity. All PLM entity types are supported by this agent and particulary customized PLM entities. This acquisition agent manages muglti-selection.

Constructor and Destructor Index

o CATPLMNavPropertiesAcquisition(CATString&,CATDlgEngBehavior)

Constructs a dialog agent that enables selection in an immersive window (Search result windows or Explore windows).

o ~CATPLMNavPropertiesAcquisition()

Destructor method of this class.

Method Index

o GetPLMIdentification(int&,CATPathIdentificators&)

Returns the list of identificators corresponding to the path of the indexed selected objects.

o GetPLMProperties(int&,CATICkeObject*&)

Returns the properties of selected object(s).

o GetSelectionCount()

Returns the number of selected objects that fit all the given criteria.

o SetPLMIdentificationFilter(CATString&,CATString&)

o SetPLMIdentificationFilter(CATPLMCoreType&,CATString&,CATString&)

o SetPLMIdentificationFilterFromType(CATIType_var&)

Filter the desired selection by type object.

Constructor and Destructor

Constructs a dialog agent that enables selection in an immersive window (Search result windows or Explore windows).

Parameters:

iId

The agent identifier.

iBehavior

The behavior of the dialog agent.
Legal values: The behavior is given as a concatenation of the facet values using the | character.
If it is NULL, the agent has the default behavior value for each facet.
e.g.: CATDlgEngMonoAcquisition, CATDlgEngWithoutSO, CATDlgEngOldHSOManager, CATDlgEngWithoutDeepSel, CATDlgEngNotValuedFromCSO, CATDlgEngSimpleValuation, CATDlgEngWithoutTooltip, CATDlgEngWithoutUserSelectionFilter
Other possible values are:

• CATDlgEngMultiAcquisition, CATDlgEngMultiAcquisitionSelModes, CATDlgEngMultiAcquisitionCtrl, CATDlgEngMultiAcquisitionUserCtrl, CATDlgEngMultiAcquisitionCtrlNoFeedback, CATDlgEngWithHSO, CATDlgEngWithPSO, CATDlgEngWithPSOHSO, CATDlgEngOldHSOManager, CATDlgWithDeepSel, CATDlgWithDeepFirstSel, CATDlgEngValuedFromCSO, CATDlgEngWithPrevaluation, CATDlgEngWithManipulation, CATDlgEngWithEdit, CATDlgEngWithContext, CATDlgEngWithDrag, CATDlgEngWithTooltip, CATDlgEngWithUserSelectionFilter.

For more details about these facets, please refers to

.

Destructor method of this class. Virtual method. No parameter.

Methods

Returns the list of identificators corresponding to the path of the indexed selected objects. In case of selection in a multi-lst, like the VPM Search result multilist, this list contains only one identificator. Other in case of selection in a 2D/3D navigator tree, this list contains the identificators of all the elements of the path of the selected object from the root to the leaf.

Parameters:

iIndex

Index to access the iIndex selected element.

oIdent

Is the type definiton of the list of CATIAdpPLMIdentificator. All the elements of the input list are removed.

Returns:

• E_INVALIDARG : if the given input index is upper to the number of selected elements or lower equal to 0.
• E_FAIL : if it fails. The returned list will be empty.
• S_OK : if the CATPathIdentificators is successfully returned.

Returns the properties of selected object(s).

Parameters:

iIndex:

index to access the iIndex selected element.

oProperties

Pointer to the returned properties of the selected element/

Returns:

• E_INVALIDARG : if the given input index is upper to the number of selected elements or lower equal to 0.
• E_FAIL : if it fails
• S_OK : if it succeeds.

Returns the number of selected objects that fit all the given criteria.

Returns:

By default return 0 if nothing has been selected.

Deprecated:

R212 : Use SetPLMIdentificationFilterFromType Filter the desired selection by modeler object.

Parameters:

iModelerName

Optional modeler name. If it is empty, it will not be relevant for filtering acquisition.

iCustoModelingName

Optional customized modeler name. If it is empty, it will not be relevant for filtering acquisition. But if it is not empty, the iModeler name should be given too.

Returns:

• S_OK : This PLM information is usable.
• S_FALSE : No type is defined in this modeler.
• E_FAIL : The designated coretype is not known by the system.
• E_INVALIDARG : The given modeler or customized modeler name is invalid.

Deprecated:

R212 : Use SetPLMIdentificationFilterFromType Filter the desired selection by type either customer or modeler object.

Parameters:

iPLMCoreType

Defines what type to select among PLM Core Types: PLMCoreReference, PLMCoreRepReference, PLMCoreInstance, PLMCoreRepInstance, PLMPort, PLMConnection).

iModelerName

Optional modeler name. If it is empty, it will not be relevant for filtering acquisition.

iCustoModelingName

Optional customized modeler name. If it is empty, it will not be relevant for filtering acquisition. But if it is not empty, the iModeler name should be given too.

Returns:

• S_OK : This PLM information is usable.
• S_FALSE : No type is defined in this modeler.
• E_FAIL : The designated coretype is not known by the system.
• E_INVALIDARG : One of the given core type, modeler or customized modeler name is invalid. Or the combinaison is not supported.

Filter the desired selection by type object.

Parameters:

ispIDataScope

Defines what type to select.

Returns:

• S_OK : This PLM information is usable.
• E_INVALIDARG : otherwise.

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