All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface ENOVIABOProductInstance

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---ENOVInterfaces.ENOVIABusinessObject
            |
            +---ENOVInterfaces.ENOVIABOProductRootClass
              |
              +---ENOVInterfaces.ENOVIABOProductSpecification
                |
                +---ENOVIABOProductInstance
 

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


interface ENOVIABOProductInstance

Interface to define Business Object view of the instance of a ProductSpecification, it is an extension of CATIAVPMItemInstance interface.
Role : As every Business Object, this interface provides a userfriendly view of some modeler objects, to hide a certain complexity and to allow an easier use of methods. In this case, a Product Instance hides the modeler object ItemInstance which points the modeler object ProductSpecification.

See also:
ENOVIABusinessObject, ENOVIABOProductSpecification, CATIAVPMItemInstance


Method Index


o AggregateSubstituteInstance(CATUnicodeString&,ENOVIABusinessObject*,CATUnicodeString&,CATMathTransformation*,ENOVIABusinessObject*&)
o AggregateSubstituteInstance(ENOVIABusinessObject_var&,ENOVIABusinessObject_var&)
Creates a Substitute Instance and adds it to the current PartInstance.
o DeleteProductInstanceAndChild()
Removes the current ProductInstance and all its children.
o IsSubstitute(CATBoolean&)
Indicates if the current ProductInstance is a Substitute Instance or not.
o get_FolderCount(CATICfgFilter*,long&,long)
Returns the number of folders under the BO with a specific config filter.
o get_ParentPartInstance(ENOVIABOPartInstance*&)
Retrieves the eventual parent PartInstance of the current ProductInstance.
o get_ParentProductComponent(long,ENOVIABOProductComponent*&)
Retrieves the ProductComponent for a given index.
o get_ParentProductComponentCount(long&)
Retrieves the number of ProductComponents associated to the current ProductInstance.
o get_ParentProductInstance(ENOVIABOProductInstance*&)
Retrieves the eventual parent ProductInstance of the current ProductInstance.
o get_ParentProductRootClass(ENOVIABOProductRootClass*&)
Retrieves the parent ProductRootClass of the current ProductInstance.
o get_ParentProductSpecification(ENOVIABOProductSpecification*&)
Retrieves the associated ProductSpecification of the current ProductInstance.
o get_PersistentInstance(ENOVIABusinessObject_var&)
Returns the persistent (=real) instance for the current item instance.
o get_Substitute(long,CATUnicodeString&,ENOVIABusinessObject*&)
o get_SubstituteBase(CATUnicodeString&,ENOVIABusinessObject*&)
o get_SubstituteBase(ENOVIABusinessObject_var&)
Retrieves the Base Instance of the current Substitute PartInstance.
o get_SubstituteCount(long&)
Retrieves the number of Substitute Instances of the current ProductInstance.
o get_SubstituteList(CATLISTV(CATBaseUnknown_var)&)
Gets the list of substitute instances for this item instance.
o put_ParentProductComponent(ENOVIABOProductComponent*)
Associates the current ProductInstance to a ProductComponent.
o put_ParentProductSpecification(ENOVIABOProductSpecification*)
Modifies the associated ProductSpecification of the current ProductInstance.

Methods


o AggregateSubstituteInstance
public virtual HRESULT __stdcall AggregateSubstituteInstance( const CATUnicodeString& iDescription,
ENOVIABusinessObject* iObjectFrom,
const CATUnicodeString& iInstanceID,
CATMathTransformation* iMatrix,
ENOVIABusinessObject*& oInstance)= 0
Deprecated:
V5R17 Creates a Substitute Instance and adds it to the current ProductInstance.
Parameters:
iDescription
The description of the substitute Instance to create.
iObjectFrom
The PartReference or the ProductSpecification to instanciate.
iInstanceID
The identifier of the substitute Instance.
iMatrix
The matrix of the substitute Instance.
oInstance
The created substitute Instance.
Returns:
S_OK in case of success, E_FAIL in case of error.
o AggregateSubstituteInstance
public virtual HRESULT __stdcall AggregateSubstituteInstance(ENOVIABusinessObject_var& iObjectFrom,
ENOVIABusinessObject_var& oInstance)= 0
Creates a Substitute Instance and adds it to the current PartInstance.
Parameters:
iObjectFrom
The PartReference or the ProductSpecification to instanciate.
oInstance
The created substitute Instance.
Returns:
S_OK in case of success, E_FAIL in case of error.
o DeleteProductInstanceAndChild
public virtual HRESULT __stdcall DeleteProductInstanceAndChild()= 0
Removes the current ProductInstance and all its children.
Returns:
S_OK in case of success, E_FAIL in case of error.
o IsSubstitute
public virtual HRESULT __stdcall IsSubstitute(CATBoolean& oIsSubstitute)= 0
Indicates if the current ProductInstance is a Substitute Instance or not.
Parameters:
oIsSubstitute
TRUE if the current ProductInstance is a Substitute Instance, FALSE if not.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_FolderCount
public virtual HRESULT __stdcall get_FolderCount(CATICfgFilter* iCfgFilter,
long& oNbItems,
long lDocLink= 1 )= 0
Returns the number of folders under the BO with a specific config filter.
Parameters:
iCfgFilter
The config filter to apply on the BO.
oNbItems
The number of folders under the BO corresponding to the config filter.
lDocLink
The Document Link to use for the search. Valid values are: 1 (default)for Instance, 2 for Reference and 0 for both.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ParentPartInstance
public virtual HRESULT __stdcall get_ParentPartInstance(ENOVIABOPartInstance*& oPartInstance)= 0
Retrieves the eventual parent PartInstance of the current ProductInstance.
Parameters:
oPartInstance
The parent PartInstance, can be NULL.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ParentProductComponent
public virtual HRESULT __stdcall get_ParentProductComponent(long iIndex,
ENOVIABOProductComponent*& oProductComponent)= 0
Retrieves the ProductComponent for a given index. It must be called after the get_ParentProductComponentCount method.
Parameters:
iIndex
The index of loop, from 1 to oNbProductComponents.
oProductComponent
The ProductComponent at the given index.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ParentProductComponentCount
public virtual HRESULT __stdcall get_ParentProductComponentCount(long& oNbProductComponents)= 0
Retrieves the number of ProductComponents associated to the current ProductInstance.
Parameters:
oNbProductComponents
The number of ProductComponents.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ParentProductInstance
public virtual HRESULT __stdcall get_ParentProductInstance(ENOVIABOProductInstance*& oProductInstance)= 0
Retrieves the eventual parent ProductInstance of the current ProductInstance.
Parameters:
oProductInstance
The parent ProductInstance, can be NULL.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ParentProductRootClass
public virtual HRESULT __stdcall get_ParentProductRootClass(ENOVIABOProductRootClass*& oProductRootClass)= 0
Retrieves the parent ProductRootClass of the current ProductInstance.
Parameters:
oProductRootClass
The parent ProductRootClass.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ParentProductSpecification
public virtual HRESULT __stdcall get_ParentProductSpecification(ENOVIABOProductSpecification*& oProductSpecification)= 0
Retrieves the associated ProductSpecification of the current ProductInstance.
Parameters:
oProductSpecification
The associated ProductSpecification.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_PersistentInstance
public virtual HRESULT __stdcall get_PersistentInstance(ENOVIABusinessObject_var& oInstance) = 0
Returns the persistent (=real) instance for the current item instance. The children of a product instance are non-persistent (= temporary) item instances which reference the underlying persistent (= real) item instance. PRC1 +----ii1|Part1--- <---------------+ [where PRC1 has a product spec, PS1] | | PRC2 | +----ii2|Part2--- (real part inst) | +----ii3|PS1 (real prod inst) | +----ii1'|Part1--- (temp ii) -----+ where ii1' is the non-persistent reference to the real ii1.
Parameters:
oInstance
The persistent II associated with the current II. If the current II is real, then current II is returned.
Returns:
S_OK if the current II is non-persistent and a persistent II is returned. S_FALSE if the current II is persistent and the current II is returned. E_FAIL in case of error.
o get_Substitute
public virtual HRESULT __stdcall get_Substitute(long iIndex,
CATUnicodeString& oDescription,
ENOVIABusinessObject*& oInstance)= 0
Deprecated:
V5R17 - use get_SubstituteList() instead Retrieves the Substitute Instance for a given index. It must be called after the get_SubstituteCount method.
Parameters:
iIndex
The index of loop, from 1 to oNbSubstitutes.
oDescription
The description of the Substitute Instance at the given index.
oInstance
The Substitute Instance at the given index.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_SubstituteBase
public virtual HRESULT __stdcall get_SubstituteBase(CATUnicodeString& oDescription,
ENOVIABusinessObject*& oInstance)= 0
Deprecated:
V5R17 - use new signature with only one parameter Retrieves the Substitute Base Instance of the current ProductInstance.
Parameters:
oDescription
The Description of the Substitute Base Instance.
oInstance
The Substitute Base Instance.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_SubstituteBase
public virtual HRESULT __stdcall get_SubstituteBase(ENOVIABusinessObject_var& oInstance)= 0
Retrieves the Base Instance of the current Substitute PartInstance.
Parameters:
oInstance
The Base Instance.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_SubstituteCount
public virtual HRESULT __stdcall get_SubstituteCount(long& oNbSubstitutes)= 0
Retrieves the number of Substitute Instances of the current ProductInstance.
Parameters:
oNbSubstitutes
The number of Substitute Instances.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_SubstituteList
public virtual HRESULT get_SubstituteList(CATLISTV(CATBaseUnknown_var)& oListSubII) = 0
Gets the list of substitute instances for this item instance.
Parameters:
oListSubII
The list of substitute instances. Can be empty.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_ParentProductComponent
public virtual HRESULT __stdcall put_ParentProductComponent(ENOVIABOProductComponent* iProductComponent)= 0
Associates the current ProductInstance to a ProductComponent.
Parameters:
iProductComponent
The ProductComponent.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_ParentProductSpecification
public virtual HRESULT __stdcall put_ParentProductSpecification(ENOVIABOProductSpecification* iProductSpecification)= 0
Modifies the associated ProductSpecification of the current ProductInstance.
Parameters:
iProductSpecification
The new associated ProductSpecification.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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