All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface ENOVIABOProductComponent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---ENOVInterfaces.ENOVIABusinessObject
|
+---ENOVIABOProductComponent
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIABOProductComponent
Interface to define the Business Object view of ProductComponent, it is an extension of CATIAVPMProductComponent interface.
Role : This interface can be used in the Server commands.
- See also:
- ENOVIABusinessObject
Method Index
- o
AggregateProductComponent(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductComponent*&)
- Creates a new ProductComponent and adds it to the current ProductComponent.
- o
AggregateProductComponent(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductComponent*&)
-
- o
IsLeaf(CATBoolean&)
- Indicates if the current ProductComponent is Leaf (no child ProductComponent) or not.
- o
IsNode(CATBoolean&)
- Indicates if the current ProductComponent is Node (one parent ProductComponent, and at least one child ProductComponent) or not.
- o
IsOrphan(CATBoolean&)
- Indicates if the current ProductComponent is Orphan (Leaf and Root) or not.
- o
IsRoot(CATBoolean&)
- Indicates if the current ProductComponent is Root (without parent ProductComponent) or not.
- o
get_ParentProductComponent(ENOVIABOProductComponent*&)
- Retrieves the eventual parent ProductComponent of the current ProductComponent.
- o
get_ParentProductRootClass(ENOVIABOProductRootClass*&)
- Retrieves the parent ProductRootClass of the current ProductComponent.
- o
get_ProductComponent(long,ENOVIABOProductComponent*&)
- Retrieves the ProductComponent for a given index.
- o
get_ProductComponentCount(long&)
- Retrieves the number of ProductComponents of the current ProductComponent.
Methods
o AggregateProductComponent
-
Creates a new ProductComponent and adds it to the current ProductComponent.
- 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 ProductComponent.
- 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 IsLeaf
-
Indicates if the current ProductComponent is Leaf (no child ProductComponent) or not.
- Parameters:
-
- oIsLeaf
- TRUE if the current ProductComponent is Leaf, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsNode
-
Indicates if the current ProductComponent is Node (one parent ProductComponent, and at least one child ProductComponent) or not.
- Parameters:
-
- oIsNode
- TRUE if the current ProductComponent is Node, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsOrphan
-
Indicates if the current ProductComponent is Orphan (Leaf and Root) or not.
- Parameters:
-
- oIsOrphan
- TRUE if the current ProductComponent is Orphan, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o IsRoot
-
Indicates if the current ProductComponent is Root (without parent ProductComponent) or not.
- Parameters:
-
- oIsRoot
- TRUE if the current ProductComponent is Root, FALSE if not.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentProductComponent
-
Retrieves the eventual parent ProductComponent of the current ProductComponent.
- Parameters:
-
- oProductComponent
- The parent ProductComponent, can be NULL.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ParentProductRootClass
-
Retrieves the parent ProductRootClass of the current ProductComponent.
- Parameters:
-
- oProductRootClass
- The parent ProductRootClass.
- 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& | oNbProductComponents)= 0 |
-
Retrieves the number of ProductComponents of the current ProductComponent.
- Parameters:
-
- oNbProductComponents
- The number of ProductComponents.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
This object is included in the file: ENOVIABOProductComponent.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces