All Frameworks Class Hierarchy This Framework Next Indexes
ENOVInterfaces Interface CATIAVPMProductSpecification3
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIAVPMProductSpecification3
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIAVPMProductSpecification3
Interface to expose the methods of the Product Specification entity.
Role: This interface exposes some of the methods of, and is implemented on, the ProductSpecification entity, for
- Retrieving the Product, Description of the ProductSpecification
- Retrieving the ItemInstances valid for the Product Specification
- Retrieving the Parent ItemInstances
Method Index
- o
Is_CarryOver()
- Checks if the ProductSpecification is CarryOver or not.
- o
get_CfgFilter(CATICfgFilter_var&)
- Retrieves the Configuration Filter maintained for the ProductSpecification.
- o
get_ConfigurableObject(CATIConfigurableObject*&)
- Retrieves the Configuration (ConfigurableObject) of the Product under which the ProductSpecification is created.
- o
get_Description(CATUnicodeString&)
- Retrieves the Description saved under this ProductSpecification.
- o
get_ItemInstances(long,CATListValCATBaseUnknown_var&)
- Retrieves the ItemInstances of the ProductSpecification's PRC that are true for this ProductSpecification.
- o
get_ParentItemInstance(long,CATIAVPMItemInstance*&)
- Retrieves the Parent ItemInstance of the ProductSpecification based on the index.
- o
get_ParentItemInstanceCount(long&)
- Retrieves the number of Parent ItemInstances of the ProductSpecification.
- o
get_ProductRootClass(CATIAVPMProductRootClass*&)
- Retrieves the Product under which this ProductSpecification is created.
- o
put_Description(CATUnicodeString&)
- Sets the Description for this ProductSpecification.
- o
set_CfgFilter(CATICfgFilter_var&)
- Creates the associated ConfigHandler if it does not exist.
Methods
o Is_CarryOver
public virtual HRESULT Is_CarryOver( | )=0 |
-
Checks if the ProductSpecification is CarryOver or not.
- Returns:
- S_OK The ProductSpecification is CarryOver S_FALSE The ProductSpecification is not CarryOver
o get_CfgFilter
public virtual HRESULT get_CfgFilter( | CATICfgFilter_var& | oCfgFilter)=0 |
-
Retrieves the Configuration Filter maintained for the ProductSpecification.
- Parameters:
-
- oCfgFilter
- Output Value - The Configuration Filter of the ProductSpecification
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ConfigurableObject
-
Retrieves the Configuration (ConfigurableObject) of the Product under which the ProductSpecification is created.
- Parameters:
-
- oConfigurableObject
- The retrieved ConfigurableObject of the Parent.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_Description
-
Retrieves the Description saved under this ProductSpecification.
- Parameters:
-
- oDescription
- The Description of this ProductSpecification.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ItemInstances
public virtual HRESULT get_ItemInstances( | long | iLevel, |
| CATListValCATBaseUnknown_var& | oListII)=0 |
-
Retrieves the ItemInstances of the ProductSpecification's PRC that are true for this ProductSpecification.
- Parameters:
-
- iLevel
- Input value - The level or mode of expansion for the ProductSpecification
Legal Values:
- n>=1 : expands n levels
- n=0 : expands ALL levels
- oListII
- Output Value - The list of instances valid for the PS
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentItemInstance
-
Retrieves the Parent ItemInstance of the ProductSpecification based on the index.
- Parameters:
-
- iIndex
- Input Value - the index for the Parent ItemInstance to retrieve; must not exceed the value returned from get_ParentItemInstanceCount
- oItemInstance
- Output Value - The parent item instance at the index
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentItemInstanceCount
public virtual HRESULT get_ParentItemInstanceCount( | long& | oNbItems)=0 |
-
Retrieves the number of Parent ItemInstances of the ProductSpecification.
The Parent ItemInstances are the instances under which this ProductSpecification is instantiated
- Parameters:
-
- oNbItems
- Output Value - The number of Parent ItemInstances
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ProductRootClass
-
Retrieves the Product under which this ProductSpecification is created.
- Parameters:
-
- oProductRootClass
- The retrieved Parent Product.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o put_Description
-
Sets the Description for this ProductSpecification.
- Parameters:
-
- iDescription
- The Description to be set.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o set_CfgFilter
public virtual HRESULT set_CfgFilter( | const CATICfgFilter_var& | iCfgFilter)=0 |
-
Creates the associated ConfigHandler if it does not exist. Sets the CfgFilter of the ConfigHandler.
- Parameters:
-
- iCfgFilter
- Input Value - The Configuration Filter for the ProductSpecification
- Returns:
- S_OK in case of success, E_FAIL in case of error.
This object is included in the file: CATIAVPMProductSpecification3.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces