All Frameworks Class Hierarchy This Framework Indexes
ENOVInterfaces Interface ENOVIABOPartInstance
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIABOPartInstance
Interface to define the Business Object view of the instance of a PartReference, 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 Part Instance hides the modeler
object ItemInstance which points the two modeler objects PartMaster and PartVersion.
- See also:
- ENOVIABusinessObject, ENOVIABOPartReference, CATIAVPMItemInstance
Method Index
- o
AggregatePartInstance(ENOVIABOPartReference*,CATUnicodeString&,ENOVIABOPartInstance*&)
-
- o
AggregatePartInstance(ENOVIABOPartReference*,CATUnicodeString&,CATUnicodeString&,ENOVIABOPartInstance*&)
- Creates a new PartInstance and adds it to the current PartInstance.
- o
AggregateProductInstance(ENOVIABOProductSpecification*,CATUnicodeString&,ENOVIABOProductInstance*&)
-
- o
AggregateProductInstance(ENOVIABOProductSpecification*,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductInstance*&)
- Creates a new ProductInstance and adds it to the current PartInstance.
- o
AggregateSubstituteInstance(ENOVIABusinessObject_var&,ENOVIABusinessObject_var&)
- Creates a Substitute Instance and adds it to the current PartInstance.
- o
AggregateSubstituteInstance(CATUnicodeString&,ENOVIABusinessObject*,CATUnicodeString&,CATMathTransformation*,ENOVIABusinessObject*&)
-
- o
CreateMaster(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOPartInstance*&)
-
- o
CreateMaster(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOPartInstance*&)
- Creates a New Part Master from the current PartInstance.
- o
DeletePartInstanceAndChild()
- Removes the current PartInstance and all its children.
- o
IsLeaf(CATICfgFilter*,CATBoolean&)
- Indicates if the current PartInstance is Leaf (no child Instance) or not.
- o
IsNode(CATICfgFilter*,CATBoolean&)
- Indicates if the current PartInstance is Node (one parent Instance, and at least one child Instance) or not.
- o
IsOrphan(CATICfgFilter*,CATBoolean&)
- Indicates if the current PartInstance is Orphan (Leaf and Root) or not.
- o
IsRoot(CATBoolean&)
- Indicates if the current PartInstance is Root (without parent Instance) or not.
- o
IsSubstitute(CATBoolean&)
- Indicates if the current PartInstance is Substitute or not.
- o
IsUptodateFromReference(CATBoolean&)
- Indicates if the current PartInstance is up to date with its reference.
- o
IsUptodate(boolean&)
- Checks if the part instance is up to date with respect to position, discrete quantity, reference, and version.
- o
IsVersionUptodate(boolean&)
- Checks if the part instance is up to date with respect to the last version.
- o
NewVersion(CATUnicodeString&,ENOVIABOPartInstance*&,ENOVIABOPartReference*)
-
- o
NewVersion(CATUnicodeString&,CATUnicodeString&,ENOVIABOPartInstance*&,ENOVIABOPartReference*)
- Creates a New Version from the current PartInstance.
- o
RemoveAllVersionsOfReference()
- Removes all the versions of the PartReference of the current PartInstance, and their instances.
- o
RemoveReference()
- Removes the PartReference of the current PartInstance and all the instances of the PartReference.
- o
SynchronizeFromReference()
- Synchronizes the current PartInstance by updating its Reference.
- 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 PartInstance.
- o
get_ParentPartReference(ENOVIABOPartReference*&)
- Retrieves the associated PartReference of the current PartInstance.
- o
get_ParentProductComponentCount(long&)
- Retrieves the number of ProductComponents associated to the current PartInstance.
- o
get_ParentProductComponent(long,ENOVIABOProductComponent*&)
- Retrieves the ProductComponent for a given index.
- o
get_ParentProductRootClass(ENOVIABOProductRootClass*&)
- Retrieves the parent ProductRootClass of the current PartInstance.
- o
get_PersistentInstance(ENOVIABusinessObject_var&)
- Returns the persistent (=real) instance for the current item instance.
- o
get_SubstituteBase(ENOVIABusinessObject_var&)
- Retrieves the Base Instance of the current Substitute PartInstance.
- o
get_SubstituteBase(CATUnicodeString&,ENOVIABusinessObject*&)
-
- o
get_SubstituteCount(long&)
- Retrieves the number of Substitute Instances of the current PartInstance.
- o
get_SubstituteList(CATLISTV(CATBaseUnknown_var)&)
- Gets the list of substitute instances for this item instance.
- o
get_Substitute(long,CATUnicodeString&,ENOVIABusinessObject*&)
-
- o
put_ParentPartReference(ENOVIABOPartReference*)
- Sets the associated PartReference of the current PartInstance.
- o
put_ParentProductComponent(ENOVIABOProductComponent*)
- Associates the current PartInstance to a ProductComponent.
Methods
o AggregatePartInstance
| public virtual AggregatePartInstance( | | iPartReference, |
| const | iinstanceID, |
| | oPartInstance) |
-
- Deprecated:
- V5R15
Creates a new PartInstance and adds it to the current PartInstance.
- Parameters:
-
- iPartReference
- The Part Reference to instanciate (mandatory).
- iinstanceID
- The identifier of the PartInstance to create (mandatory).
- oPartInstance
- The created PartInstance.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o AggregatePartInstance
| public virtual AggregatePartInstance( | | iPartReference, |
| const | iinstanceID, |
| const | iEnvironment, |
| | oPartInstance) |
-
Creates a new PartInstance and adds it to the current PartInstance.
- Parameters:
-
- iPartReference
- The Part Reference to instanciate (mandatory).
- iinstanceID
- The identifier of the PartInstance to create (mandatory).
- iEnvironment
- The environment in which the PartInstance will be created (mandatory).
- oPartInstance
- The created PartInstance.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o AggregateProductInstance
| public virtual AggregateProductInstance( | | iProductSpecification, |
| const | iInstanceID, |
| | oProductInstance) |
-
- Deprecated:
- V5R15
Creates a new ProductInstance and adds it to the current PartInstance.
- Parameters:
-
- iProductSpecification
- The ProductSpecification to instanciate (mandatory).
- iInstanceID
- The identifier of the ProductInstance to create (mandatory).
- oProductInstance
- The created ProductInstance.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o AggregateProductInstance
| public virtual AggregateProductInstance( | | iProductSpecification, |
| const | iInstanceID, |
| const | iEnvironment, |
| | oProductInstance) |
-
Creates a new ProductInstance and adds it to the current PartInstance.
- Parameters:
-
- iProductSpecification
- The ProductSpecification to instanciate (mandatory).
- iInstanceID
- The identifier of the ProductInstance to create (mandatory).
- iEnvironment
- The environment in which the ProductInstance will be created (mandatory).
- oProductInstance
- The created ProductInstance.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o AggregateSubstituteInstance
| public virtual AggregateSubstituteInstance( | | iObjectFrom, |
| | oInstance) |
-
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 AggregateSubstituteInstance
| public virtual AggregateSubstituteInstance( | const | iDescription, |
| | iObjectFrom, |
| const | iInstanceID, |
| | iMatrix, |
| | oInstance) |
-
- Deprecated:
- V5R17
Creates a Substitute Instance and adds it to the current PartInstance.
- 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 CreateMaster
| public virtual CreateMaster( | const | iID, |
| const | iName, |
| const | iDescription, |
| | oNewPartInstance) |
-
- Deprecated:
- V5R15
Creates a New Part Master from the current PartInstance.
- Parameters:
-
- iID
- The identifier of the Part Master to create (mandatory).
- iName
- The name of the Part Master to create (optional).
- iDescription
- The description of the Part Master to create (optional).
- oNewPartInstance
- The created PartInstance.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o CreateMaster
| public virtual CreateMaster( | const | iID, |
| const | iName, |
| const | iDescription, |
| const | iEnvironment, |
| | oNewPartInstance) |
-
Creates a New Part Master from the current PartInstance.
- Parameters:
-
- iID
- The identifier of the Part Master to create (mandatory).
- iName
- The name of the Part Master to create (optional).
- iDescription
- The description of the Part Master to create (optional).
- iEnvironment
- The environment in which the new Part Master will be created.
- oNewPartInstance
- The created PartInstance.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o DeletePartInstanceAndChild
| public virtual DeletePartInstanceAndChild( | ) |
-
Removes the current PartInstance and all its children.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsLeaf
| public virtual IsLeaf( | | iCfgFilter, |
| | oIsLeaf) |
-
Indicates if the current PartInstance is Leaf (no child Instance) or not.
- Parameters:
-
- iCfgFilter
- The Configuration Filter in which the analysis is done (can be NULL).
- oIsLeaf
- TRUE if the current PartInstance is Leaf, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsNode
| public virtual IsNode( | | iCfgFilter, |
| | oIsNode) |
-
Indicates if the current PartInstance is Node (one parent Instance, and at least one child Instance) or not.
- Parameters:
-
- iCfgFilter
- The Configuration Filter in which the analysis is done (can be NULL).
- oIsNode
- TRUE if the current PartInstance is Node, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsOrphan
| public virtual IsOrphan( | | iCfgFilter, |
| | oIsOrphan) |
-
Indicates if the current PartInstance is Orphan (Leaf and Root) or not.
- Parameters:
-
- iCfgFilter
- The Configuration Filter in which the analysis is done (can be NULL).
- oIsOrphan
- TRUE if the current PartInstance is Orphan, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsRoot
| public virtual IsRoot( | | oIsRoot) |
-
Indicates if the current PartInstance is Root (without parent Instance) or not.
- Parameters:
-
- oIsRoot
- TRUE if the current PartInstance is Root, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsSubstitute
| public virtual IsSubstitute( | | oIsSubstitute) |
-
Indicates if the current PartInstance is Substitute or not.
- Parameters:
-
- oIsSubstitute
- TRUE if the current PartInstance is a Substitute Instance, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsUptodateFromReference
| public virtual IsUptodateFromReference( | | oStatus) |
-
Indicates if the current PartInstance is up to date with its reference.
- Parameters:
-
- oStatus
- The Up to date From Reference status.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsUptodate
| public virtual IsUptodate( | | Status) |
-
Checks if the part instance is up to date with respect to position, discrete quantity, reference, and version.
- Parameters:
-
- Status
- TRUE or FALSE, meaningful only if S_OK is the return code
- Returns:
- S_OK if success, E_FAIL if failure
o IsVersionUptodate
| public virtual IsVersionUptodate( | | Status) |
-
Checks if the part instance is up to date with respect to the last version.
- Parameters:
-
- Status
- TRUE or FALSE, meaningful only if S_OK is the return code
- Returns:
- S_OK if success, E_FAIL if failure
o NewVersion
| public virtual NewVersion( | const | iVersion, |
| | oNewPartInstance, |
| | iFromPartRef | = 0 ) |
-
- Deprecated:
- V5R15
Creates a New Version from the current PartInstance.
- Parameters:
-
- iVersion
- The Version Id.
- oNewPartInstance
- The created PartInstance.
- iFromPartRef
- is the PartReference the new version inherites from (optional).
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o NewVersion
| public virtual NewVersion( | const | iVersion, |
| const | iEnvironment, |
| | oNewPartInstance, |
| | iFromPartRef | = 0 ) |
-
Creates a New Version from the current PartInstance.
- Parameters:
-
- iVersion
- The Version Id.
- oNewPartInstance
- The created PartInstance.
- iFromPartRef
- is the PartReference the new version inherites from (optional).
- iEnvironment
- The environment in which the New Version will be created.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o RemoveAllVersionsOfReference
| public virtual RemoveAllVersionsOfReference( | ) |
-
Removes all the versions of the PartReference of the current PartInstance, and their instances.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o RemoveReference
| public virtual RemoveReference( | ) |
-
Removes the PartReference of the current PartInstance and all the instances of the PartReference.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o SynchronizeFromReference
| public virtual SynchronizeFromReference( | ) |
-
Synchronizes the current PartInstance by updating its Reference.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_FolderCount
| public virtual get_FolderCount( | | iCfgFilter, |
| | oNbItems, |
| | lDocLink | = 1 ) |
-
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 get_ParentPartInstance( | | oParentPartInstance) |
-
Retrieves the eventual parent PartInstance of the current PartInstance.
- Parameters:
-
- oParentPartInstance
- The parent PartInstance, can be NULL.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentPartReference
| public virtual get_ParentPartReference( | | oPartReference) |
-
Retrieves the associated PartReference of the current PartInstance.
- Parameters:
-
- oPartReference
- The associated PartReference.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentProductComponentCount
| public virtual get_ParentProductComponentCount( | | oNbProductComponents) |
-
Retrieves the number of ProductComponents associated to the current PartInstance.
- Parameters:
-
- oNbProductComponents
- The number of ProductComponents.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentProductComponent
| public virtual get_ParentProductComponent( | | iIndex, |
| | oProductComponent) |
-
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_ParentProductRootClass
| public virtual get_ParentProductRootClass( | | oProductRootClass) |
-
Retrieves the parent ProductRootClass of the current PartInstance.
- Parameters:
-
- oProductRootClass
- The parent ProductRootClass.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_PersistentInstance
| public virtual get_PersistentInstance( | | oInstance) |
-
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_SubstituteBase
| public virtual get_SubstituteBase( | | oInstance) |
-
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_SubstituteBase
| public virtual get_SubstituteBase( | | oDescription, |
| | oInstance) |
-
- Deprecated:
- V5R17 - use new signature with only one parameter
Retrieves the Substitute Base Instance of the current PartInstance.
- 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_SubstituteCount
| public virtual get_SubstituteCount( | | oNbSubstituteInstances) |
-
Retrieves the number of Substitute Instances of the current PartInstance.
- Parameters:
-
- oNbSubstituteInstances
- The number of Substitute Instances.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_SubstituteList
| public virtual get_SubstituteList( | | oListSubII) |
-
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 get_Substitute
| public virtual get_Substitute( | | iIndex, |
| | oDescription, |
| | oInstance) |
-
- 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 oNbSubstituteInstances.
- 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 put_ParentPartReference
| public virtual put_ParentPartReference( | | iPartReference) |
-
Sets the associated PartReference of the current PartInstance.
- Parameters:
-
- iPartReference
- The associated PartReference.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o put_ParentProductComponent
| public virtual put_ParentProductComponent( | | iProductComponent) |
-
Associates the current PartInstance to a ProductComponent.
- Parameters:
-
- iProductComponent
- The ProductComponent.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
This object is included in the file: ENOVIABOPartInstance.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces