All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATImmENOVIAProvider Class CATImmIdentifierAcquisitionAgent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATEventSubscriber
|
+---System.CATCommand
|
+---DialogEngine.CATDialogAgent
|
+---DialogEngine.CATAcquisitionAgent
|
+---DialogEngine.CATPathElementAgent
|
+---CATImmIdentifierAcquisitionAgent
Usage: you must use this class as is. You should never derive it.
public class CATImmIdentifierAcquisitionAgent
Aquisition Agent for VPMNav views.
Role Class providing MVC CAA control to go from VPMNav presentation views to ENOVIA model information.
Constructor and Destructor Index
- o
CATImmIdentifierAcquisitionAgent(CATDlgEngBehavior)
- * constructor
- o
~CATImmIdentifierAcquisitionAgent()
-
Method Index
- o
GetIdentificator(CATIPLMIdentificator**)
- * Retreive the identificator of the ENOVIAvpm Object acquired.
- o
GetIdentifiers(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
- * Retreive the identifiers of the ENOVIAvpm Object acquired.
- o
GetType()
- * Retreive the domain & type of the ENOVIAvpm Object acquired.
Constructor and Destructor
o CATImmIdentifierAcquisitionAgent
-
* constructor
- Parameters:
-
- iBehavior
- iBehavior can be CATDlgEngSimpleValuation and CATDlgEngWithPrevaluation.
Default is CATDlgEngSimpleValuation.
*
o ~CATImmIdentifierAcquisitionAgent
public virtual ~CATImmIdentifierAcquisitionAgent( | ) |
-
Methods
o GetIdentificator
-
* Retreive the identificator of the ENOVIAvpm Object acquired.
Role : Identificator are used to interoperate between various element of the architecture
Identificator can be used
- to Run a service on the ENOVIA server,
- to retreive if the object is currently loadded in the CATIA session,
- to compare two navigation objects
- Parameters:
-
- opId
- The ENOVIA navigation model identifier
- Returns:
- S_OK when identifiers can be all retrieved otherwise E_FAIL.*
o GetIdentifiers
-
* Retreive the identifiers of the ENOVIAvpm Object acquired.
Role : Identifiers are Unique key attributes by which one can retrieve by query a single one object
in providing the key attributes value.
- Parameters:
-
- oNames
- The names of the identifier attributes
e.g.: For VPMPartVersion
"V_id"
or "V_version"
will compose the list
- oValues
- The values of the identifier attributes.
For each identifier attribute in the list oNames correspond a value (at same rank) in the oValues list.
- Returns:
- S_OK when identifiers can be all retrieved otherwise E_FAIL.*
o GetType
-
* Retreive the domain & type of the ENOVIAvpm Object acquired.
Role:Once Acquisition is Valuated, returns the domain & type of the acquired information.
With the current behavior, only VPMPartVersion & VPMDocumentRevision or
one of a customer derived class can be returned as type
Notice that other inherited method from DialogAgent like GetValue, GetElementValue should not be used.
- Returns:
- the type of the ENOVIAvpm object e.g.: For VPMPartVersion class
"PRODUCT/VPMPartVersion"
string should be returned
*
This object is included in the file: CATImmIdentifierAcquisitionAgent.h
If needed, your Imakefile.mk should include the module: CATImmIdAcqAgent