All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIConfigurable

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIConfigurable
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIConfigurable



Method Index


o AttachProgram(CATICfgProgram_var&)
Attach a Program to this Configurable.
o AttachSpec(CATICfgSimpleSpecification_var&)
Attach a Specification to this Configurable.
o AttachSpecCategory(CATICfgSpecCategory_var&,int)
Attach a Specification Category to this Configurable.
o CreateAttachment(CATICfgAttachable_var&,CATICfgLnk_var&)
Attach a Spec, Category, programm, milestone .
o CreateConfigurableView(CATUnicodeString&,CATIConfigurableObject_var&)
Create a Configurable View( Configurable Object) under the Configurable.
o CreateProductType(CATUnicodeString&,CATICfgProductType_var&)
Creates a New Product Type.
o DeleteAttachment(CATICfgAttachable_var&)
Detach a Spec, Category, programm, milestone .
o DetachProgram(CATICfgProgram_var&)
Detach a Program from this Configurable.
o DetachSpec(CATICfgSimpleSpecification_var&)
Detach a Specification from this Configurable.
o DetachSpecCategory(CATICfgSpecCategory_var&)
Detach a Specification Category from this Configurable.
o GetConfigurableView(CATListValCATIConfigurableObject_var&)
Return the List of Configurable Objects belonging to this Configurable.
o GetDescription(CATUnicodeString&)
Return the Description of this Configurable.
o GetListOfMileStoneValue(CATListOfCATICfgMileStoneValue_var&)
Return the List of MilestoneValue links on this Configurable.
o GetListOfProgram(CATListValCATICfgProgram_var&)
Return the List of Programs linked to this Configurable.
o GetObject(SEQUENCE(octet)&)
Return the UUID of the Object linked to this Configurable.
o GetSpecCategory(CATListValCATICfgSpecCategory_var&)
Return the List of SpecCategories belonging to this Configurable.
o GetSpecExpression(CATListValCATICfgSpecExpression_var&)
Return the List of SpecExpressions belonging to this Configurable.
o GetSpecInclusion(CATListValCATICfgSpecInclusion_var&)
Return the List of SpecInclusions belonging to this Configurable.
o GetSpecLnkType(CATICfgSimpleSpecification_var&,CATICfgSpecLnk::Type&)
Return the type of the SpecLnk between this Configurable and a SimpleSpecification.
o GetSpecification(CATICfgSpecCategory_var&,CATICfgSpecLnk::Type,CATListValCATICfgSimpleSpecification_var&)
Return the List of SimpleSpecifications belonging to this Configurable for a given SpecCategory and SpecLnk type.
o GetSpecification(CATListValCATICfgSimpleSpecification_var&)
Return the List of SimpleSpecifications belonging to this Configurable.
o GetTypeDefiningCategories(CATListOfCATICfgSpecCategory_var&)
Retrieve all categories which are TypeDefining for this Configurable
o IsSpecTypeDefining(CATICfgSimpleSpecification_var&,int&)
Find outif a Specification can be used to define a PT built on this CO
o QueryAttachment(CATICfgAttachable_var&,CATICfgLnk_var&)
Query for the attachment between this CO and iAttachable
o QueryMileStoneValueByMileStone(CATICfgMileStone_var&,CATICfgMileStoneValue_var&)
Return the MilestoneValue between a Milestone and this Configurable.
o SetDescription(CATUnicodeString&)
Set the Description of this Configurable.
o SetSpecLnkType(CATICfgSimpleSpecification_var&,CATICfgSpecLnk::Type)
Set the type of the SpecLnk between this Configurable and a SimpleSpecification.

Methods


o AttachProgram
public virtual HRESULT AttachProgram( const CATICfgProgram_var& inProgram) = 0
Attach a Program to this Configurable.
Postcondition: Each Milestone of the Program is attached to the Configurable. For each Milestone, a MilestoneValue is created using Milestone's default Value.
Parameters:
inProgram
Program to attach.
o AttachSpec
public virtual HRESULT AttachSpec( const CATICfgSimpleSpecification_var& iSpec) = 0
Attach a Specification to this Configurable.
Parameters:
iSpec
Specification to attach.
o AttachSpecCategory
public virtual HRESULT AttachSpecCategory( const CATICfgSpecCategory_var& iSpecCat,
int iIsMandatory=0) = 0
Attach a Specification Category to this Configurable.
Parameters:
iSpecCat
Specification Category to attach.
o CreateAttachment
public virtual HRESULT CreateAttachment( const CATICfgAttachable_var& iAttachable,
CATICfgLnk_var& oLnk) const = 0
Attach a Spec, Category, programm, milestone ... to this CO
Parameters:
iAttachable
The object to attach.
oLnk
The link created between this CO and iAttachable.
o CreateConfigurableView
public virtual HRESULT CreateConfigurableView( const CATUnicodeString& iCVName,
CATIConfigurableObject_var& oCV) = 0
Create a Configurable View( Configurable Object) under the Configurable.
Parameters:
iCVName
Configurable View's name.
oCV
Configurable View created.
o CreateProductType
public virtual HRESULT CreateProductType( const CATUnicodeString& iName,
CATICfgProductType_var& oProdType) = 0
Creates a New Product Type.
Parameters:
iName
Input value - Name of Product Type to be created
oProdType
Output value - Product Type created
Returns:
An HRESULT
Legal values:
S_OK
The Product Type is created successfully and the interface pointer is successfully returned
S_FALSE
A Product Type with the iName exists already and the interface pointer is successfully returned
E_FAIL
Failed to Create the Product Type
o DeleteAttachment
public virtual HRESULT DeleteAttachment( const CATICfgAttachable_var& iAttachable) const = 0
Detach a Spec, Category, programm, milestone ... from this CO
Parameters:
iAttachable
The object to detach.
o DetachProgram
public virtual HRESULT DetachProgram( const CATICfgProgram_var& inProgram) = 0
Detach a Program from this Configurable.
Postcondition: If any Milestone of the Program is used, the method does nothing, and returns E_FAIL. Else, the method deletes each of the MilestoneValues between the Milestones and the Configurable.
Parameters:
inProgram
Program to detach.
o DetachSpec
public virtual HRESULT DetachSpec( const CATICfgSimpleSpecification_var& iSpec) = 0
Detach a Specification from this Configurable.
Parameters:
iSpecCat
Specification to detach.
o DetachSpecCategory
public virtual HRESULT DetachSpecCategory( const CATICfgSpecCategory_var& iSpecCat) = 0
Detach a Specification Category from this Configurable.
Parameters:
iSpecCat
Specification Category to detach.
o GetConfigurableView
public virtual HRESULT GetConfigurableView(CATListValCATIConfigurableObject_var& oList) const = 0
Return the List of Configurable Objects belonging to this Configurable.
Parameters:
oList
List of Configurable Objects.
o GetDescription
public virtual HRESULT GetDescription(CATUnicodeString& oDescription) const = 0
Return the Description of this Configurable.
Parameters:
oDescription
The Configurable Description.
o GetListOfMileStoneValue
public virtual HRESULT GetListOfMileStoneValue(CATListOfCATICfgMileStoneValue_var& outMileStoneValueList) = 0
Return the List of MilestoneValue links on this Configurable.
Parameters:
outMileStoneValueList
List of MilestoneValue links to return.
o GetListOfProgram
public virtual HRESULT GetListOfProgram(CATListValCATICfgProgram_var& outProgramList) = 0
Return the List of Programs linked to this Configurable.
Parameters:
outProgramList
List of Programs to return.
o GetObject
public virtual HRESULT GetObject(SEQUENCE(octet)& oUID) const = 0
Return the UUID of the Object linked to this Configurable.
Parameters:
oUID
UUID of the Object.
o GetSpecCategory
public virtual HRESULT GetSpecCategory(CATListValCATICfgSpecCategory_var& oList) const = 0
Return the List of SpecCategories belonging to this Configurable.
Parameters:
oList
List of SpecCategories to return.
o GetSpecExpression
public virtual HRESULT GetSpecExpression(CATListValCATICfgSpecExpression_var& oList) const = 0
Return the List of SpecExpressions belonging to this Configurable.
Parameters:
oList
List of SpecExpressions to return.
o GetSpecInclusion
public virtual HRESULT GetSpecInclusion(CATListValCATICfgSpecInclusion_var& oList) const = 0
Return the List of SpecInclusions belonging to this Configurable.
Parameters:
oList
List of SpecInclusions to return.
o GetSpecLnkType
public virtual HRESULT GetSpecLnkType(CATICfgSimpleSpecification_var& iSpecification,
CATICfgSpecLnk::Type& oLnkType) = 0
Return the type of the SpecLnk between this Configurable and a SimpleSpecification.
Parameters:
iSpecification
SimpleSpecification the Configurable is supposed to be linked with.
oLnkType
SpecLnk type to return.
Legal values: replaceable_standard, non_replaceable_standard, availability, identification, option.
o GetSpecification
public virtual HRESULT GetSpecification(CATICfgSpecCategory_var& iCategory,
CATICfgSpecLnk::Type iLinkType,
CATListValCATICfgSimpleSpecification_var& oList) = 0
Return the List of SimpleSpecifications belonging to this Configurable for a given SpecCategory and SpecLnk type.
Parameters:
iCategory
SpecCategory.
iLinkType
SpecLnk type.
Legal values: replaceable_standard, non_replaceable_standard, availability, identification, option.
oList
List of SimpleSpecifications to return.
o GetSpecification
public virtual HRESULT GetSpecification(CATListValCATICfgSimpleSpecification_var& oList) const = 0
Return the List of SimpleSpecifications belonging to this Configurable.
Parameters:
oList
List of SimpleSpecifications to return.
o GetTypeDefiningCategories
public virtual HRESULT GetTypeDefiningCategories(CATListOfCATICfgSpecCategory_var& oList) const = 0
Retrieve all categories which are TypeDefining for this Configurable
Parameters:
oList
List of Type defining categories.
o IsSpecTypeDefining
public virtual HRESULT IsSpecTypeDefining( const CATICfgSimpleSpecification_var& iSpec,
int& oPTSpec) const = 0
Find outif a Specification can be used to define a PT built on this CO
Parameters:
iSpec
Specification to test.
oPTSpec
0: Spec can not be used to define a PT built on this CO. 1: Spec can be used to define a PT built on this CO.
o QueryAttachment
public virtual HRESULT QueryAttachment( const CATICfgAttachable_var& iAttachable,
CATICfgLnk_var& oLnk) const = 0
Query for the attachment between this CO and iAttachable
Parameters:
iAttachable
Object that has been attached to this CO using CreateAttachment.
oLnk
The link between this CO and iAttachable.
o QueryMileStoneValueByMileStone
public virtual HRESULT QueryMileStoneValueByMileStone( const CATICfgMileStone_var& inMileStone,
CATICfgMileStoneValue_var& outMileStoneValue) = 0
Return the MilestoneValue between a Milestone and this Configurable.
Parameters:
inMileStone
Milestone supposed to be linked with the Configurable.
outMileStoneValue
MilestoneValue to return.
o SetDescription
public virtual HRESULT SetDescription( const CATUnicodeString& iDescr) = 0
Set the Description of this Configurable.
Parameters:
iDescr
The Configurable Description.
o SetSpecLnkType
public virtual HRESULT SetSpecLnkType(CATICfgSimpleSpecification_var& iSpecification,
CATICfgSpecLnk::Type iLnkType) = 0
Set the type of the SpecLnk between this Configurable and a SimpleSpecification.
Parameters:
iSpecification
SimpleSpecification the Configurable is supposed to be linked with.
iLnkType
SpecLnk type to set.
Legal values: replaceable_standard, non_replaceable_standard, availability, identification, option.

This object is included in the file: CATIConfigurable.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.