All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMInterfaces Interface 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 AttachSpecCategory(CATICfgSpecCategory_var&,int)
Attach a Specification Category to this Configurable.
o AttachSpec(CATICfgSimpleSpecification_var&)
Attach a Specification 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 DetachSpecCategory(CATICfgSpecCategory_var&)
Detach a Specification Category from this Configurable.
o DetachSpec(CATICfgSimpleSpecification_var&)
Detach a Specification 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(CATListValCATICfgSimpleSpecification_var&)
Return the List of SimpleSpecifications belonging to this Configurable.
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 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 AttachProgram( const inProgram)
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 AttachSpecCategory
public virtual AttachSpecCategory( const iSpecCat,
iIsMandatory=0)
Attach a Specification Category to this Configurable.
Parameters:
iSpecCat
Specification Category to attach.
o AttachSpec
public virtual AttachSpec( const iSpec)
Attach a Specification to this Configurable.
Parameters:
iSpec
Specification to attach.
o CreateAttachment
public virtual CreateAttachment( const iAttachable,
oLnk)
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 CreateConfigurableView( const iCVName,
oCV)
Create a Configurable View( Configurable Object) under the Configurable.
Parameters:
iCVName
Configurable View's name.
oCV
Configurable View created.
o CreateProductType
public virtual CreateProductType( const iName,
oProdType)
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 DeleteAttachment( const iAttachable)
Detach a Spec, Category, programm, milestone ... from this CO
Parameters:
iAttachable
The object to detach.
o DetachProgram
public virtual DetachProgram( const inProgram)
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 DetachSpecCategory
public virtual DetachSpecCategory( const iSpecCat)
Detach a Specification Category from this Configurable.
Parameters:
iSpecCat
Specification Category to detach.
o DetachSpec
public virtual DetachSpec( const iSpec)
Detach a Specification from this Configurable.
Parameters:
iSpecCat
Specification to detach.
o GetConfigurableView
public virtual GetConfigurableView( oList)
Return the List of Configurable Objects belonging to this Configurable.
Parameters:
oList
List of Configurable Objects.
o GetDescription
public virtual GetDescription( oDescription)
Return the Description of this Configurable.
Parameters:
oDescription
The Configurable Description.
o GetListOfMileStoneValue
public virtual GetListOfMileStoneValue( outMileStoneValueList)
Return the List of MilestoneValue links on this Configurable.
Parameters:
outMileStoneValueList
List of MilestoneValue links to return.
o GetListOfProgram
public virtual GetListOfProgram( outProgramList)
Return the List of Programs linked to this Configurable.
Parameters:
outProgramList
List of Programs to return.
o GetObject
public virtual GetObject( oUID)
Return the UUID of the Object linked to this Configurable.
Parameters:
oUID
UUID of the Object.
o GetSpecCategory
public virtual GetSpecCategory( oList)
Return the List of SpecCategories belonging to this Configurable.
Parameters:
oList
List of SpecCategories to return.
o GetSpecExpression
public virtual GetSpecExpression( oList)
Return the List of SpecExpressions belonging to this Configurable.
Parameters:
oList
List of SpecExpressions to return.
o GetSpecInclusion
public virtual GetSpecInclusion( oList)
Return the List of SpecInclusions belonging to this Configurable.
Parameters:
oList
List of SpecInclusions to return.
o GetSpecLnkType
public virtual GetSpecLnkType( iSpecification,
oLnkType)
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 GetSpecification( oList)
Return the List of SimpleSpecifications belonging to this Configurable.
Parameters:
oList
List of SimpleSpecifications to return.
o GetSpecification
public virtual GetSpecification( iCategory,
iLinkType,
oList)
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 GetTypeDefiningCategories
public virtual GetTypeDefiningCategories( oList)
Retrieve all categories which are TypeDefining for this Configurable
Parameters:
oList
List of Type defining categories.
o IsSpecTypeDefining
public virtual IsSpecTypeDefining( const iSpec,
oPTSpec)
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 QueryAttachment( const iAttachable,
oLnk)
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 QueryMileStoneValueByMileStone( const inMileStone,
outMileStoneValue)
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 SetDescription( const iDescr)
Set the Description of this Configurable.
Parameters:
iDescr
The Configurable Description.
o SetSpecLnkType
public virtual SetSpecLnkType( iSpecification,
iLnkType)
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.