All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface ENOVIABOProductRootClass
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---ENOVInterfaces.ENOVIABusinessObject
|
+---ENOVIABOProductRootClass
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIABOProductRootClass
Interface to define the Business Object view of ProductRootClass, it is an extension of CATIAVPMProductRootClass interface.
Role : This interface can be used in the Server commands.
- See also:
- CATIAVPMProductRootClass, ENOVIABusinessObject
Method Index
- o
AggregatePartInstance(ENOVIABOPartReference*,CATUnicodeString&,CATUnicodeString&,ENOVIABOPartInstance*&)
- Creates a new PartInstance and adds it to the current ProductRootClass.
- o
AggregatePartInstance(ENOVIABOPartReference*,CATUnicodeString&,ENOVIABOPartInstance*&)
-
- o
AggregateProductComponent(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductComponent*&)
- Creates a new ProductComponent and adds it to the current ProductRootClass.
- o
AggregateProductComponent(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductComponent*&)
-
- o
AggregateProductInstance(ENOVIABOProductSpecification*,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductInstance*&)
- Creates a new ProductInstance and adds it to the current ProductRootClass.
- o
AggregateProductInstance(ENOVIABOProductSpecification*,CATUnicodeString&,ENOVIABOProductInstance*&)
-
- o
AggregateProductSpecification(CATIConfigurableObject*,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductSpecification*&)
- Creates a new ProductSpecification and adds it to the current ProductRootClass.
- o
AggregateProductSpecification(CATIConfigurableObject*,CATUnicodeString&,ENOVIABOProductSpecification*&)
-
- o
get_ParentProductClass(ENOVIABOProductClass*&)
- Retrieves the parent ProductClass of the current ProductRootClass.
- o
get_ProductComponent(long,ENOVIABOProductComponent*&)
- Retrieves the ProductComponent for a given index.
- o
get_ProductComponentCount(long,long&)
- Retrieves the number of ProductComponents of the current ProductRootClass.
- o
get_ProductSpecification(long,ENOVIABOProductSpecification*&)
- Retrieves the ProductSpecification for a given index.
- o
get_ProductSpecificationCount(long&)
- Retrieves the number of ProductSpecifications of the current ProductRootClass.
Methods
o AggregatePartInstance
-
Creates a new PartInstance and adds it to the current ProductRootClass.
- 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 AggregatePartInstance
-
- Deprecated:
- V5R15
Creates a new PartInstance and adds it to the current ProductRootClass.
- 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 AggregateProductComponent
-
Creates a new ProductComponent and adds it to the current ProductRootClass.
- Parameters:
-
- iId
- The identifier of the ProductComponent to create (mandatory).
- iName
- The name of the ProductComponent to create (optional).
- iDescription
- The description of the ProductComponent to create (optional).
- iEnvironment
- The environment in which the ProductComponent will be created (mandatory).
- oProductComponent
- The created ProductComponent.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o AggregateProductComponent
-
- Deprecated:
- V5R15
Creates a new ProductComponent and adds it to the current ProductRootClass.
- Parameters:
-
- iId
- The identifier of the ProductComponent to create (mandatory).
- iName
- The name of the ProductComponent to create (optional).
- iDescription
- The description of the ProductComponent to create (optional).
- oProductComponent
- The created ProductComponent.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o AggregateProductInstance
-
Creates a new ProductInstance and adds it to the current ProductRootClass.
- 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 AggregateProductInstance
-
- Deprecated:
- V5R15
Creates a new ProductInstance and adds it to the current ProductRootClass.
- 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 AggregateProductSpecification
-
Creates a new ProductSpecification and adds it to the current ProductRootClass.
- Parameters:
-
- iConfigurableObject
- The associated ConfigurableObject to manage configuration data (optional).
- iVersion
- The version of the ProductSpecification to create (mandatory).
- iEnvironment
- The environment in which the ProductSpecification will be created (mandatory).
- oProductSpecification
- The created ProductSpecification.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o AggregateProductSpecification
-
- Deprecated:
- V5R15
Creates a new ProductSpecification and adds it to the current ProductRootClass.
- Parameters:
-
- iConfigurableObject
- The associated ConfigurableObject to manage configuration data (optional).
- iVersion
- The version of the ProductSpecification to create (mandatory).
- oProductSpecification
- The created ProductSpecification.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentProductClass
-
Retrieves the parent ProductClass of the current ProductRootClass.
- Parameters:
-
- oProductClass
- The parent ProductClass.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ProductComponent
-
Retrieves the ProductComponent for a given index. It must be called after the get_ProductComponentCount 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_ProductComponentCount
public virtual HRESULT __stdcall get_ProductComponentCount( | long | iMode, |
| long& | oNbProductComponents)= 0 |
-
Retrieves the number of ProductComponents of the current ProductRootClass.
- Parameters:
-
- iMode
- This parameter allows to filter the ProductComponents.
iMode = PS_ALL of CATVpmPSInclude.h ==> All
iMode = PS_ROOT of CATVpmPSInclude.h ==> ProductComponent Root (no ProductComponent parent)
iMode = PS_LEAF of CATVpmPSInclude.h ==> ProductComponent Leaf (no ProductComponent child)
iMode = PS_NODE of CATVpmPSInclude.h ==> ProductComponent Node (one ProductComponent parent, at least one ProductComponent child)
iMode = PS_ORPHAN of CATVpmPSInclude.h ==> ProductComponent Orphan (Leaf and Root)
Combinations of mode are possible.
- oNbProductComponents
- The number of ProductComponents.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ProductSpecification
-
Retrieves the ProductSpecification for a given index. It must be called after the get_ProductSpecificationCount method.
- Parameters:
-
- iIndex
- The index of loop, from 1 to oNbProductSpecifications.
- oProductSpecification
- The ProductSpecification at the given index.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ProductSpecificationCount
public virtual HRESULT __stdcall get_ProductSpecificationCount( | long& | oNbProductSpecifications)= 0 |
-
Retrieves the number of ProductSpecifications of the current ProductRootClass.
- Parameters:
-
- oNbProductSpecifications
- The number of ProductSpecifications.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
This object is included in the file: ENOVIABOProductRootClass.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces