All Frameworks Class Hierarchy This Framework Indexes
ENOVInterfaces Interface ENOVISupportedPS
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVISupportedPS
Interface to expose the methods for As-Supported ProductSpecifications.
Role: This interface exposes the methods for As-Supported ProductSpecifications functionality and is implemented on the ProductSpecification entity.
- Retrieving the As-Supported ProductSpecifications of 'this' ProductSpecification
- Retrieving the As-Designed of a given ProductSpecification
- Creating the As-Supported ProductSpecifications for a given ProductSpecification
Method Index
- o
get_AsDesignedProductSpec(CATBaseUnknown_var&)
- Gets the As-Designed ProductSpecification.
- o
get_AsSupportedConfigFilter(CATICfgFilter_var&)
- Gets the As-Supported ProductSpec's Configuration Filter.
- o
get_AsSupportedProductSpecs(CATLISTV(CATBaseUnknown_var)&)
- Gets the As-Supported ProductSpecs.
- o
set_AsDesignedProductSpec(CATBaseUnknown_var&)
- Sets the As-Designed ProductSpecification.
- o
set_AsSupportedProductSpec(CATBaseUnknown_var&)
- Sets the As-Supported ProductSpecification.
Methods
o get_AsDesignedProductSpec
| public virtual get_AsDesignedProductSpec( | | oAsDesigned) |
-
Gets the As-Designed ProductSpecification.
- Parameters:
-
- oAsDesigned
- Output value - The As-Designed ProductSpecification
- Returns:
- An HRESULT
Legal values:
- S_OK
- The As-Designed ProductSpecification is returned
- S_FALSE
- The As-Designed ProductSpecification does not exist
- E_FAIL
- Failed to retrieve the As-Designed ProductSpecification
o get_AsSupportedConfigFilter
| public virtual get_AsSupportedConfigFilter( | | oCfgFilter) |
-
Gets the As-Supported ProductSpec's Configuration Filter.
- Parameters:
-
- oCfgFilter
- Output value - The Configuration Filter which contains the combined filter criteria of As-Supported and its As-Designed PS
- Returns:
- An HRESULT
Legal values:
- S_OK
- The Config Filter is successfully retrieved
- E_FAIL
- Failed to get the As-Supported ProductSpecification Config Filter
o get_AsSupportedProductSpecs
| public virtual get_AsSupportedProductSpecs( | | oAsSupported) |
-
Gets the As-Supported ProductSpecs.
- Parameters:
-
- oAsSupported
- Output value - List of As-Supported ProductSpecs
- Returns:
- An HRESULT
Legal values:
- S_OK
- The As-Supported ProductSpecs returned successfully
- E_FAIL
- Failed to retrieve the As-Supported ProductSpecification
o set_AsDesignedProductSpec
| public virtual set_AsDesignedProductSpec( | const | iAsDesigned) |
-
Sets the As-Designed ProductSpecification.
- Parameters:
-
- iAsDesigned
- Input value - The As-Designed ProductSpecification
- Returns:
- An HRESULT
Legal values:
- S_OK
- The As-Designed ProductSpecification is Set
- E_FAIL
- Failed to set the As-Designed ProductSpecification
o set_AsSupportedProductSpec
| public virtual set_AsSupportedProductSpec( | const | iAsSupported) |
-
Sets the As-Supported ProductSpecification.
- Parameters:
-
- iAsSupported
- Input value - The As-Supported ProductSpecification
- Returns:
- An HRESULT
Legal values:
- S_OK
- The As-Supported ProductSpecification is Set
- E_FAIL
- Failed to set the As-Supported ProductSpecification
This object is included in the file: ENOVISupportedPS.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces