All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface ENOVIVariantConfigurable
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIVariantConfigurable
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIVariantConfigurable
Interface to retrieve the attached Specifications, Rules on a Configurable and get each of theirs effectivity.
Role: The ENOVIVariantConfigurable enables you to:
- Get the attached Specifications, Rules.
- Get the effectivity of the attached variant.
- This interface is implemented on the ENOVIA_CFGABLE object, to retrieve this interface handler
- developers should first be able to get the CATIConfigurable_var of the configured PRC or a Part, then query interface
- on that CATIConfigurable_var to get the interface pointer of ENOVIVariantConfigurable.
Method Index
- o
Add(CATILinkableObject_var&)
- Performs the "Add" operation on the object.
- o
Add(CATILinkableObject_var&,CATILinkableObject_var&)
- Performs the "Add" operation on the object.
- o
Cut(CATILinkableObject_var&)
- Performs the "Cut" operation on the object.
- o
Cut(CATILinkableObject_var&,CATILinkableObject_var&)
- Performs the "Cut" operation on the object.
- o
GetAttachedExpressions(CATLISTV(CATBaseUnknown_var)&)
- Gets Attached ExpressionSpecs.
- o
GetAttachedInclusions(CATLISTV(CATBaseUnknown_var)&)
- Gets Attached InclusionSpecs.
- o
GetAttachedSpecs(CATLISTV(CATBaseUnknown_var)&)
- Gets Attached Specifications.
- o
GetEffectivityAsString(CATBaseUnknown_var&,CATUnicodeString&)
- Gets the effectivity of the attached Specification or inclusion or expression.
Methods
o Add
public virtual HRESULT Add( | const CATILinkableObject_var& | iAddedObject) = 0 |
-
Performs the "Add" operation on the object.
- Parameters:
-
- iAddedObject
- Input value - The object on which the "Add" operation will be performed
- Returns:
- An HRESULT
Legal values:
- S_OK
- The "Cut" operation was performed successfully
- S_FALSE
- Failed to perform the "Cut" operation due to other reason such as object not configured
- E_FAIL
- Failed to perform the "Cut" operation
o Add
public virtual HRESULT Add( | const CATILinkableObject_var& | iAddedObject, |
| const CATILinkableObject_var& | iFather) = 0 |
-
Performs the "Add" operation on the object.
- Parameters:
-
- iAddedObject
- Input value - The object on which the "Add" operation will be performed
- iFather
- Input value - The parent object of the object on which the "Add" operation will be performed
- Returns:
- An HRESULT
Legal values:
- S_OK
- The "Cut" operation was performed successfully
- S_FALSE
- Failed to perform the "Cut" operation due to other reason such as object not configured
- E_FAIL
- Failed to perform the "Cut" operation
o Cut
public virtual HRESULT Cut( | const CATILinkableObject_var& | iCutObject) = 0 |
-
Performs the "Cut" operation on the object.
- Parameters:
-
- iAddedObject
- Input value - The object on which the "Cut" operation will be performed
- Returns:
- An HRESULT
Legal values:
- S_OK
- The "Cut" operation was performed successfully
- S_FALSE
- Failed to perform the "Cut" operation due to other reason such as object not configured
- E_FAIL
- Failed to perform the "Cut" operation
o Cut
public virtual HRESULT Cut( | const CATILinkableObject_var& | iCutObject, |
| const CATILinkableObject_var& | iFather) = 0 |
-
Performs the "Cut" operation on the object.
- Parameters:
-
- iAddedObject
- Input value - The object on which the "Cut" operation will be performed
- iFather
- Input value - The parent object of the object on which the "Cut" operation will be performed
- Returns:
- An HRESULT
Legal values:
- S_OK
- The "Cut" operation was performed successfully
- S_FALSE
- Failed to perform the "Cut" operation due to other reason such as object not configured
- E_FAIL
- Failed to perform the "Cut" operation
o GetAttachedExpressions
-
Gets Attached ExpressionSpecs.
- Parameters:
-
- oSpecs
- Output value - Attached ExpressionSpecs of the Product or PartMaster.
- Returns:
- An HRESULT
Legal values:
- S_OK
- There are ExpressionSpecs Attached to this Configurable and are returned
- S_FALSE
- There are no ExpressionSpecs Attached to this Configurable size of oSpecs is 0
- E_FAIL
- Failed to check or retrieve attached ExpressionSpecs
o GetAttachedInclusions
-
Gets Attached InclusionSpecs.
- Parameters:
-
- oSpecs
- Output value - Attached InclusionSpecs of the Product or PartMaster.
- Returns:
- An HRESULT
Legal values:
- S_OK
- There are InclusionSpecs Attached to this Configurable and are returned
- S_FALSE
- There are no InclusionSpecs Attached to this Configurable size of oSpecs is 0
- E_FAIL
- Failed to check or retrieve attached InclusionSpecs
o GetAttachedSpecs
-
Gets Attached Specifications.
- Parameters:
-
- oSpecs
- Output value - Attached Specifications of the Product or PartMaster.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- There are Specs Attached to this Configurable and are returned
- S_FALSE
- There are no Specs Attached to this Configurable size of oSpecs is 0
- E_FAIL
- Failed to check or retrieve attached Specifications
o GetEffectivityAsString
-
Gets the effectivity of the attached Specification or inclusion or expression.
- Parameters:
-
- iVariant
- Input value - Attached Specification or Expression or Inclusion of the Product or PartMaster.
- oEffectivity
- Output value - Effectivity of the Attached variant.
- Returns:
- An HRESULT
Legal values:
- S_OK
- There are ExpressionSpecs Attached to this Configurable and are returned
- E_FAIL
- Failed to check or retrieve the effectivity
This object is included in the file: ENOVIVariantConfigurable.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces