All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATICfgManager
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICfgManager
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICfgManager
Class to manage most creations and queries of objects used in the context of product Configuration.
Role: A Configuration Manager is a generic object used as a factory for a number of
objects like Effectivites, Configurable Object, ANDExpression , Filter.....
It also serves as a base object supporting methods dedicated to queries.
Method Index
- o
AllowApplicability(CATIConfigurableObject_var&,SEQUENCE(CORBAAny)&,CATListOfCATUnicodeString&,CATListOfCATICfgORExpression_var&,short&)
- Check on the server if at least one of provided Item Instances is under an action.
- o
AllowExpandApplicability(CATIConfigurableObject_var&,SEQUENCE(CORBAAny)&,CATListOfCATUnicodeString&,CATListOfCATICfgORExpression_var&,short&)
- Check on the server if at least one of provided Item Instances is under an action.
- o
CATDeclareHandler(CATICfgManager,CATBaseUnknown)
-
- o
Cancel(CATListValCATICfgModification_var&)
- Cancels a list of modifications.
- o
CreateANDExpression(CATICfgANDExpression_var&)
- Create an ANDExpression.
- o
CreateBasicEffectivity(CATCfgVal&,CATCfgVal&,CATICfgSpecANDExpression_var&,CATUnicodeString&,CATUnicodeString&,CATICfgBasicEffectivity_var&)
- Creates a valued BasicEffectivity
- o
CreateBasicEffectivity(CATICfgBasicEffectivity_var&)
- Creates an empty BasicEffectivity
- o
CreateConfigurable(CATILinkableObject_var&,CATUnicodeString&,CATIConfigurable_var&)
- Create a new configurable (Referenced as CO).
- o
CreateConfigurable(SEQUENCE(octet)&,CATUnicodeString&,CATIConfigurable_var&)
- Create a new configurable (Referenced as CO).
- o
CreateConfigurableObject(CATILinkableObject_var&,CATUnicodeString&,CATIConfigurableObject_var&)
- Create a new configurable object (Referenced as CV).
- o
CreateConfigurableObject(SEQUENCE(octet)&,CATUnicodeString&,CATIConfigurableObject_var&)
- Create a new configurable object (Referenced as CV).
- o
CreateDateInterval(CATTime&,CATICfgInterval_var&)
- Create an infinite Date interval.
- o
CreateDateInterval(CATTime&,CATTime&,CATICfgInterval_var&)
- Create an Date interval.
- o
CreateEffectivity(CATICfgEffectivity_var&)
- Creates an empty Effectivity.
- o
CreateFilter(CATICfgFilter_var&)
-
- o
CreateFilter(CATIConfigurableObject_var&,CATUnicodeString&,CATICfgFilter_var&)
-
- o
CreateFilter(CATListValCATIConfigurableObject_var&,CATUnicodeString&,CATICfgFilter_var&)
-
- o
CreateInterval(CATCfgVal&,CATCfgVal&,CATICfgInterval_var&)
- Create Interval from CATICfgVal variable.
- o
CreateInterval(CATICfgValue_var&,CATICfgValue_var&,CATICfgInterval_var&)
- Create Interval from CATICfgValue variable.
- o
CreateInterval(char*,CATICfgInterval_var&)
- Create Interval from xml string.
- o
CreateModContainer(CATICfgModContainer_var&)
- Creates a new Modification Container object.
- o
CreateMultiLevelFilter(CATUnicodeString&,CATICfgFilter_var&)
- Create a Configuration Filter usable to filter any object, regardless to their
associated Configuration Objects.
- o
CreateNormalValue(CATICfgInterval_var&,CATICfgNormalValue_var&)
- Create a normal value limited to a range, a date or a condition.
- o
CreateNormalValue(CATICfgModification_var&,CATICfgNormalValue_var&)
- Create a normal Value from a modification.
- o
CreateNormalValue(CATICfgSimpleSpecification_var&,CATICfgNormalValue_var&)
- Create a normal value limited to a simple specification.
- o
CreateNormalValue(CATTime&,CATTime&,CATICfgNormalValue_var&)
- Create a Date normal value .
- o
CreateNormalValue(int,int,CATICfgNormalValue_var&)
- Create a Range normal value .
- o
CreateORExpression(CATICfgORExpression_var&)
- Create an ORExpression.
- o
CreateProgram(CATUnicodeString&,CATICfgProgram_var&)
- Create a Program with a given name.
- o
CreateRangeInterval(int&,int&,CATICfgInterval_var&)
- Create an Range interval.
- o
CreateSignedSpec(CATICfgSignedSpec_var&)
- Create Signed specification.
- o
CreateSpecANDExp(CATICfgSpecANDExpression_var&)
- Create SpecANDExp expression.
- o
CreateSpecCategory(CATUnicodeString&,CATUnicodeString&,CATICfgSpecCategory_var&,CORBAAny*)
- Create Specification category.
- o
CreateUndefInterval(CATICfgInterval_var&)
- Create an Undefined interval.
- o
CreateVariabilitySpace(CATUnicodeString&,CATICfgVariabilitySpace_var&)
- Create a Variability Space object by name.
- o
CreateXEff(CATUnicodeString&,CATICfgXEff_var&)
- Creates an XEff.
- o
GetBSFNames(CATListOfCATUnicodeString&)
- Get BSF names.
- o
GetCanceled(CATListValCATICfgModification_var&)
- Retrieve all the canceled modifications.
- o
GetComputedEffectivity(CATILinkableObject_var&,CATListOfCATICfgXEff_var&,CATListOfInt&,CATListOfCATICfgModification_var&,int&,CATBoolean)
- Compute the Effectivity
- o
GetComputedEffectivityStatus(CATUnicodeString&,CATILinkableObject_var&,int&)
- Method to get the status of computed effectivity
- o
GetConfigHandlerByIdent(SEQUENCE(octet)&,CATIConfigHandler_var&)
- Retrieve Config handler by its Unique Identifier.
- o
GetContributingObjectList(CATILinkableObject_var&,CATListOfCATILinkableObject&,CATListOfCATIConfigurableObject_var&,CATILinkableObject_var&,CATIConfigurableObject_var&)
- Returns the list of CATILinkableObjects and CATIConfigurableObjects contributing
to the effectivity of a specified object.
- o
GetDomainList(CATListOfCATUnicodeString&,int)
- Get the list of all defined domains ( Engineering, Manufacturing.
- o
GetEffectivityByIdent(SEQUENCE(octet)&,CATICfgModification_var&)
- Retrieve an Effectivity by its Identifier.
- o
GetErrorMsg(int&,CATUnicodeString&)
- Get error Message.
- o
GetFullSpecName(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Build the full name of a specification from for Category Name, and Spec name.
- o
GetListOfFilters(CATListValCATICfgFilter_var&)
- Get every filters defined in the active session.
- o
GetRealFilterableObject(CATILinkableObject_var&,CATILinkableObject_var&,CATIConfigurableObject_var&)
- Retrieves the object handling the effectivity of a filterable object (typically an Item Instance).
- o
GetStringEffectivity(CATILinkableObject_var&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&)
- Retrieve String Effectivity by its Unique CATILinkableObject.
- o
GetStringEffectivity(CATILinkableObject_var&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Retrieve String Effectivity by its Unique CATILinkableObject.
- o
IsComputedEffectivityNull(CATILinkableObject_var&,int&)
- Test if the Computed Effectivity is null
- o
PopInfo(CATUnicodeString&)
- Retrieve the error messages pushed
- o
QueryAllConfigurable(CATListOfCATIConfigurable_var&)
- Retrieve all Configurables.
- o
QueryAllConfigurableObject(CATListOfCATIConfigurableObject_var&)
- Retrieve all configurable objects
- o
QueryAllModHistory(CATListOfCATICfgHistory_var&)
-
Query all ModHistory
- o
QueryAllVariabilitySpace(CATListValCATICfgVariabilitySpace_var&)
- Retrieve all Variability Space Objects.
- o
QueryConfigHandler(CORBAAny&,CATUnicodeString&,CATICfgManager::QueryOperator,CATListOfCATIConfigHandler_var&)
- Query Config Handler.
- o
QueryConfigHandlerForCO(CORBAAny&,CATUnicodeString&,CATICfgManager::QueryOperator,CATIConfigurableObject_var&,CATListOfCATIConfigHandler_var&)
- Query Config Handler(s) on a Configurable Object.
- o
QueryConfigurableByObject(SEQUENCE(octet)&,CATIConfigurable_var&)
- Retrieve Configurable by its Unique Identifier.
- o
QueryConfigurableObject(CATILinkableObject_var&,CATUnicodeString&,CATListOfCATIConfigurableObject_var&)
- Retrieve Configurable Object carried by an object, its name being known.
- o
QueryConfigurableObject(SEQUENCE(octet)&,CATUnicodeString&,CATListOfCATIConfigurableObject_var&)
- Retrieve Configurable Object carried by an object, its name being known.
- o
QueryConfigurableObjectByName(CATICfgManager::QueryOperator,CATUnicodeString&,CATListOfCATIConfigurableObject_var&)
- Retrieve Configurable Objects by name.
- o
QueryConfigurableObjectByObject(CATILinkableObject_var&,CATListOfCATIConfigurableObject_var&)
- Retrieve Configurable Objects carried by an object.
- o
QueryConfigurableObjectByObject(SEQUENCE(octet)&,CATListOfCATIConfigurableObject_var&)
- Retrieve Configurable Objects carried by an object.
- o
QueryEffValByObject(CORBAAny&,CATListOfCATICfgEffVal_var&)
- Query an EffVal by object (UUID).
- o
QueryEffectivities(SEQUENCE(octet)&,CATListOfCATICfgModification_var&)
- Retrieve all effectivities pointing to a Filterable Object.
- o
QueryEffectivitiesByCO(SEQUENCE(octet)&,CATIConfigurableObject_var&,CATListOfCATICfgModification_var&)
- Retrieve all effectivities belonging to a Configurable Object and pointing to a filterable Object.
- o
QueryEffectivitiesByName(CATUnicodeString&,CATListOfCATICfgModification_var&)
- Query Effectivities knowing their name.
- o
QueryMileStoneByName(CATUnicodeString&,CATICfgMileStone_var&)
- Query MileStones with a given name.
- o
QueryModContainerByDescription(CATUnicodeString&,CATListValCATICfgModContainer_var&)
- Retrieves a list of Modification Containers according to their description attribute.
- o
QueryModHistoryByObject(SEQUENCE(octet)&,CATListOfCATICfgHistory_var&,CATIVpmPredicate_var&,CATUnicodeString&)
-
Query all ModHistory by Object
- o
QueryModificationListByNameList(CATListOfCATUnicodeString&,CATListOfCATICfgModification_var&)
- Query Modification from their name.
- o
QueryNormalValuesByMileStoneName(CATUnicodeString&,CATListOfCATICfgNormalValue_var&)
- Query Normal values using a given MileStone.
- o
QueryProductType(CORBAAny&,CATUnicodeString&,CATICfgManager::QueryOperator,CATListOfCATICfgProductType_var&)
- Query ProductTypes from known attibute.
- o
QueryProgramByName(CATUnicodeString&,CATICfgProgram_var&)
- Query Program with a given name.
- o
QuerySimpleSpec(CORBAAny&,CATUnicodeString&,CATICfgManager::QueryOperator,CATListOfCATICfgSimpleSpecification_var&)
- Query Simple Specifications from known attibute.
- o
QuerySimpleSpecForCategory(CORBAAny&,CATUnicodeString&,CATICfgManager::QueryOperator,CATICfgSpecCategory_var&,CATListOfCATICfgSimpleSpecification_var&)
- Query Simple Specifications from known attibute on a given Specification Category.
- o
QuerySimpleSpecList(CATListOfCATUnicodeString&,CATListOfCATICfgSimpleSpecification_var&)
- Query Simple Specifications from their full name.
- o
QuerySpecCategories(CORBAAny&,CATUnicodeString&,CATICfgManager::QueryOperator,CATListOfCATICfgSpecCategory_var&)
- Query Specification Categories from known attibute.
- o
QueryVariabilitySpaceByName(CATUnicodeString&,CATICfgVariabilitySpace_var&)
- Retrieve a Variability Space Object with a given name if exist.
- o
RemoveConfigHandler(CATIConfigHandler_var&)
- Remove a Config Handler.
- o
RemoveConfigurable(CATIConfigurable_var&)
- Destroy Configurable, and all Configurable Object and Effectivities associated to it.
- o
RemoveSpecCategory(CATICfgSpecCategory_var&)
- Delete a Spec Category.
- o
RetrieveFilter(SEQUENCE(octet)&,CATICfgFilter_var&)
- Retrieve a Configuration Filter according to its Symbolic Link.
- o
TransferMod(CATILinkableObject_var&,CATICfgModification_var&,CATICfgModification_var&,CATListOfInt&,CATBoolean,CATBoolean)
- Method to transfer a modification used within an object's effectivity to another action.
- o
TransferModWithAction(CATICfgModification_var,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,boolean,CATUnicodeString&)
- Method to transfer a modification linked to Action or ECO.
- o
WhereConfigHandlerUsed(CATIConfigHandler_var&,CATUnicodeString&,CATListOfCATIConfigHandler_var&)
- Query Config Handler(s) "Children" or "Brothers" of a given Config Handler.
- o
WhereNormalValueUsed(CATICfgNormalValue_var&,CATListOfCATICfgModification_var&,CATListOfCATIConfigHandler_var&)
- Find all the modifications and Config Handlers using a Normal Value.
Enumerated Type Index
- o
ComputedEffectivityStatus
- Enum defined to identify various states of a computed effectivity.
- o
FilterMode
- Enumeration
- o
Operations
-
- o
QueryOperator
- Enumeration
- o
ResolutionStatus
-
Methods
o AllowApplicability
-
Check on the server if at least one of provided Item Instances is under an action.
Role : If it is the case, then do not permit user to Edit Applicability !
If not, return the Effectivity which points to all the Item Instances ....
...or no Effectivity if at least two of the Item Instances don't have the same Effectivity.
All these checks are made by the method AllowApplicability.
This method takes a list of filterableObjects and returns one or two nodes.
The first node returned is a status :
0 indicates that All the filterable objects are sharing the same effectivity stored in the second node.
1 indicates that Two of the filterable objects are not sharing the same effectivity.
2 indicates that at least one of filterable objects is under an action.
The status will be stored as a short in the level attribute of the first node.
- Parameters:
-
- CO
- Configurable object to inspect.
- iIIUIDs
- List of Item Instance Unique Identifiers.
- oDomainsLists
- Lists of Domains
- oORExpList
- List of ORExpression
o AllowExpandApplicability
-
Check on the server if at least one of provided Item Instances is under an action.
Role : If it is the case, them do not permit to Extend/Expand Applicability !
If not, return the Effectivity which points to all the Item Instances ....
...or no Effectivity if at least two of the Item Instances don't have the same Effectivity.
All these checks are made by the method AllowApplicability.
This method takes a list of filtrableObjects and returns one or two nodes.
The first node returned is a status :
0 indicates that All the filtrable objects are sharing the same effectivity stored in the second node.
1 indicates that Two of the filtrable objects are not sharing the same effectivity.
2 indicates that at least one of filtrable objects is under an action.
This short will be stored in the level attribute of the first node.
- Parameters:
-
- CO
- Configurable object to inspect.
- iIIUIDs
- List of Item Instance Unique Identifiers.
- oDomainsLists
- Lists of Domains
- oORExpList
- List of ORExpression
o CATDeclareHandler
-
o Cancel
public virtual HRESULT Cancel( | const CATListValCATICfgModification_var& | iListMod) = 0 |
-
Cancels a list of modifications.
- Parameters:
-
- iListMod
- List of Modifications to Cancel.
Modifications are not deleted but flagged 'Canceled' and therefore not taken into account when filtering.
o CreateANDExpression
public virtual HRESULT CreateANDExpression( | CATICfgANDExpression_var& | oValue) const = 0 |
-
Create an ANDExpression.
- Parameters:
-
- oValue
- Created ANDExpression.
o CreateBasicEffectivity
public virtual HRESULT CreateBasicEffectivity( | const CATCfgVal& | ValStart, |
| const CATCfgVal& | ValEnd, |
| const CATICfgSpecANDExpression_var& | iSpecExp, |
| const CATUnicodeString& | iStartMileStoneExp, |
| const CATUnicodeString& | iEndMileStoneExp, |
| CATICfgBasicEffectivity_var& | oEffectivity) = 0 |
-
Creates a valued BasicEffectivity
- Parameters:
-
- ValStart
- Start Value for Basic Effectivity.
- ValStart
- End Value for Basic Effectivity.
- iSpecExp
- SpecANDExpression for Basic Effectivity
- iStartMileStoneExp
- Start MileStone Expression for Basic Effecitivity.
- iEndMileStoneExp
- End MileStone Expresssiob for Basic Effectivity.
- oEffectivity
- The Effectivity to create.
o CreateBasicEffectivity
public virtual HRESULT CreateBasicEffectivity( | CATICfgBasicEffectivity_var& | oEffectivity) = 0 |
-
Creates an empty BasicEffectivity
- Parameters:
-
- oEffectivity
- The Effectivity to create.
o CreateConfigurable
public virtual HRESULT CreateConfigurable( | const CATILinkableObject_var& | iObj, |
| const CATUnicodeString& | iDescription, |
| CATIConfigurable_var& | oCfgable)=0 |
-
Create a new configurable (Referenced as CO).
- Parameters:
-
- iObj
- Object (Product Root Class, Manufacturing Plan. ...) to configure.
- iDescription
- Configurable's unique Name.
- oCfgable
- The created Configurable.
o CreateConfigurable
public virtual HRESULT CreateConfigurable( | SEQUENCE(octet)& | iUuid, |
| const CATUnicodeString& | iDescription, |
| CATIConfigurable_var& | oCfgable)=0 |
-
Create a new configurable (Referenced as CO).
- Parameters:
-
- iObjectUuid
- UUID of the Object (Product Root Class, Manufacturing Plan. ...) to configure.
- iDescription
- Configurable's unique Name.
- oCfgable
- The created Configurable.
o CreateConfigurableObject
public virtual HRESULT CreateConfigurableObject( | const CATILinkableObject_var& | iObj, |
| const CATUnicodeString& | iName, |
| CATIConfigurableObject_var& | oCfgable) = 0 |
-
Create a new configurable object (Referenced as CV).
- Parameters:
-
- iObj
- Object (Product Root Class, Manufacturing Plan. ...) to configure.
- iName
- Configurable Object's unique Name.
- oCfgable
- the created Configurable Object.
o CreateConfigurableObject
public virtual HRESULT CreateConfigurableObject( | SEQUENCE(octet)& | iObjectUuid, |
| const CATUnicodeString& | iName, |
| CATIConfigurableObject_var& | oCfgable) = 0 |
-
Create a new configurable object (Referenced as CV).
- Parameters:
-
- iObjectUuid
- UUID of the Object (Product Root Class, Manufacturing Plan. ...) to configure.
- iName
- Configurable Object's unique Name.
- oCfgable
- the created Configurable Object.
o CreateDateInterval
public virtual HRESULT CreateDateInterval( | const CATTime& | iBegDate, |
| CATICfgInterval_var& | oInterval) const = 0 |
-
Create an infinite Date interval.
- Parameters:
-
- iBegDate
- Start Date for the interval.
- oInterval
- Created Interval.
o CreateDateInterval
public virtual HRESULT CreateDateInterval( | const CATTime& | iBegDate, |
| const CATTime& | iEndDate, |
| CATICfgInterval_var& | oInterval) const = 0 |
-
Create an Date interval.
- Parameters:
-
- iBegDate
- Start Date for the interval.
- iEndDate
- End Date for the interval.
- oInterval
- Created Interval.
o CreateEffectivity
public virtual HRESULT CreateEffectivity( | CATICfgEffectivity_var& | oEffectivity) = 0 |
-
Creates an empty Effectivity.
- Parameters:
-
- oEffectivity
- The Effectivity to create.
o CreateFilter
public virtual HRESULT CreateFilter( | CATICfgFilter_var& | oFilter)const = 0 |
-
- Deprecated:
- V5R14 CreateMultiLevelFilter
Create a Configuration Filter on a list of Configurable Objects.
- Parameters:
-
- oFilter
- Created Filter.
o CreateFilter
public virtual HRESULT CreateFilter( | const CATIConfigurableObject_var& | iContext, |
| const CATUnicodeString& | iDomain, |
| CATICfgFilter_var& | oFilter)const = 0 |
-
- Deprecated:
- V5R14 CreateMultiLevelFilter
Create a Configuration Filter on a configurable object.
- Parameters:
-
- iCfgObj
- The Configurable object to define filter on.
- iDomainName
- Name of the Domain ( Engineering, Manufacturing...).
- oFilter
- Created Filter.
o CreateFilter
public virtual HRESULT CreateFilter( | const CATListValCATIConfigurableObject_var& | iContextList, |
| const CATUnicodeString& | iDomain, |
| CATICfgFilter_var& | oFilter)const = 0 |
-
- Deprecated:
- V5R14 CreateMultiLevelFilter
Create a Configuration Filter on a list of Configurable Objects.
- Parameters:
-
- iListCfgObj
- The List of Configurable objects to define filter on.
- iDomainName
- Nom de Domaine ( Engineering, Manufacturing...).
- oFilter
- Created Filter.
o CreateInterval
public virtual HRESULT CreateInterval( | const CATCfgVal& | iStart, |
| const CATCfgVal& | iLast, |
| CATICfgInterval_var& | oInterval) const = 0 |
-
Create Interval from CATICfgVal variable.
- Parameters:
-
- iStart
- Start value.
- iLast
- End Value.
- oInterval
- Created Interval.
o CreateInterval
public virtual HRESULT CreateInterval( | const CATICfgValue_var& | iStart, |
| const CATICfgValue_var& | iLast, |
| CATICfgInterval_var& | oInterval) const = 0 |
-
Create Interval from CATICfgValue variable.
- Parameters:
-
- iStart
- Start value.
- iLast
- End Value.
- oInterval
- Created Interval.
o CreateInterval
public virtual HRESULT CreateInterval( | const char* | iXmlString, |
| CATICfgInterval_var& | oInterval) = 0 |
-
Create Interval from xml string.
- Parameters:
-
- iXmlString
- xml string.
- oInterval
- Created Interval.
o CreateModContainer
public virtual HRESULT CreateModContainer( | CATICfgModContainer_var& | oModContainer)const = 0 |
-
Creates a new Modification Container object.
- Parameters:
-
- oModContainer
- : the Modification Container created
- Returns:
- : - S_OK if all is correct
- E_FAIL if an error occured
o CreateMultiLevelFilter
-
Create a Configuration Filter usable to filter any object, regardless to their
associated Configuration Objects.
- Parameters:
-
- iDomain
- Filtering domain name ( Engineering, Manufacturing...).
- oFilter
- Created Filter.
o CreateNormalValue
public virtual HRESULT CreateNormalValue( | const CATICfgInterval_var& | iInterval, |
| CATICfgNormalValue_var& | oValue) const = 0 |
-
Create a normal value limited to a range, a date or a condition.
- Parameters:
-
- iInterval
- Interval. Can be Date or Range Interval.
- oValue
- Created Normal Value
o CreateNormalValue
public virtual HRESULT CreateNormalValue( | const CATICfgModification_var& | iCfgMod, |
| CATICfgNormalValue_var& | oValue) const = 0 |
-
Create a normal Value from a modification.
- Parameters:
-
- oCfgMod
- Modification.
- oValue
- Created normal value.
o CreateNormalValue
public virtual HRESULT CreateNormalValue( | const CATICfgSimpleSpecification_var& | iCfgSimpleSpec, |
| CATICfgNormalValue_var& | oValue) const = 0 |
-
Create a normal value limited to a simple specification.
- Parameters:
-
- oValue
- Created Normal Value.
o CreateNormalValue
public virtual HRESULT CreateNormalValue( | const CATTime& | iBegDate, |
| const CATTime& | iEndDate, |
| CATICfgNormalValue_var& | oValue) const = 0 |
-
Create a Date normal value .
- Parameters:
-
- iBegDate
- Start Date.
- iEndDate
- End Date.
- oValue
- Created Normal Value.
o CreateNormalValue
public virtual HRESULT CreateNormalValue( | const int | iStartRange, |
| const int | iLastRange, |
| CATICfgNormalValue_var& | oValue) const = 0 |
-
Create a Range normal value .
- Parameters:
-
- iStartRange
- Start Range.
- iLastRange
- End Range.
- oValue
- Created Normal Value.
o CreateORExpression
public virtual HRESULT CreateORExpression( | CATICfgORExpression_var& | oValue) const = 0 |
-
Create an ORExpression.
- Parameters:
-
- oValue
- Created ORExpression.
o CreateProgram
-
Create a Program with a given name.
- Parameters:
-
- iName
- Input Name.
- outProgram
- Created Program.
o CreateRangeInterval
public virtual HRESULT CreateRangeInterval( | const int& | iStartRange, |
| const int& | EndRange, |
| CATICfgInterval_var& | oInterval) const = 0 |
-
Create an Range interval.
- Parameters:
-
- iStartRange
- Start Date for the interval.
- iEndRange
- End Date for the interval.
- oInterval
- Created Interval.
o CreateSignedSpec
public virtual HRESULT CreateSignedSpec( | CATICfgSignedSpec_var& | oSignedSpec) = 0 |
-
Create Signed specification.
- Parameters:
-
- oSignedSpec
- Created Signed spec.
o CreateSpecANDExp
public virtual HRESULT CreateSpecANDExp( | CATICfgSpecANDExpression_var& | oSpecANDExp) = 0 |
-
Create SpecANDExp expression.
- Parameters:
-
- oSpecANDExp
- Created SpecANDExpression.
o CreateSpecCategory
-
Create Specification category.
- Parameters:
-
- iName
- Name of Specification Category to create.
- iDescription
- Free string describing the SpecCategory.
- CfgSpecCategory
- Created SpecCategory.
- iPtrURL
- Identifier of the created SpecCategory.
o CreateUndefInterval
public virtual HRESULT CreateUndefInterval( | CATICfgInterval_var& | oInterval) const = 0 |
-
Create an Undefined interval.
- Parameters:
-
- oInterval
- Created Interval.
o CreateVariabilitySpace
public virtual HRESULT CreateVariabilitySpace( | const CATUnicodeString& | in_Name, |
| CATICfgVariabilitySpace_var& | out_VariabilitySpace)const =0 |
-
Create a Variability Space object by name.
- Parameters:
-
- in_Name
- VariabilitySpace name to create.
- out_VariabilitySpace
- Created VariabilitySpace.
o CreateXEff
-
Creates an XEff.
- Parameters:
-
- iDomain
- Domain corresponding to XEff
- oXEff
- The XEff to create.
o GetBSFNames
-
Get BSF names.
o GetCanceled
public virtual HRESULT GetCanceled( | CATListValCATICfgModification_var& | oListMod) const = 0 |
-
Retrieve all the canceled modifications.
- Parameters:
-
- ListMod
- Retrieved List of canceled Modifications .
GetCanceled DO NOT clean oListMod. It allows you to reuse oListMod thanks to multiple calls to GetCanceled.
o GetComputedEffectivity
-
Compute the Effectivity
- Parameters:
-
- iObj
- : the object (ItemInstance) symbolic link
- oComputedEffectivity
- : the main result
- oContributionTypes
- : contributing result
- oContributingMods
- : contributing result
- oResolutionStatus
- : result flag to be checked against ResolutionStatus
- iForceComputation
- : flag to force the computation
- Returns:
- : - S_OK if all is correct
- E_FAIL if an error occured
o GetComputedEffectivityStatus
public virtual HRESULT GetComputedEffectivityStatus( | const CATUnicodeString& | iDomain, |
| const CATILinkableObject_var& | iObj, |
| int& | oComputedEffectivityStatus)const = 0 |
-
Method to get the status of computed effectivity
- Parameters:
-
- iDomain
- Effectivity Domain on which the status is required
- iObj
- The object on which the effectivity status is to be found
- oComputedEffectivityStatus
- Computed effectivity status
- Returns:
- HRESULT
S_OK : if all is correct
E_FAIL : if an error occured
o GetConfigHandlerByIdent
public virtual HRESULT GetConfigHandlerByIdent( | const SEQUENCE(octet)& | iId, |
| CATIConfigHandler_var& | oConfHand) const=0 |
-
Retrieve Config handler by its Unique Identifier.
- Parameters:
-
- iId
- Config Handler's UUID.
- oConfHand
- Retrieved Config Handler.
o GetContributingObjectList
public virtual HRESULT GetContributingObjectList( | const CATILinkableObject_var& | iObj, |
| CATListOfCATILinkableObject& | oLinkableList, |
| CATListOfCATIConfigurableObject_var& | oCVList, |
| CATILinkableObject_var& | oTerminalLinkable, |
| CATIConfigurableObject_var& | oTerminalCV)const = 0 |
-
Returns the list of CATILinkableObjects and CATIConfigurableObjects contributing
to the effectivity of a specified object.
Only the CATILinkableObjects with NON NULL CATIConfigurableObject are returned.
Therefore, only NON NULL CATIConfigurableObject are returned.
- Parameters:
-
- iUid
- : the object (ItemInstance) symbolic link
- oLinkableList
- : the list of CATILinkableObjects
- oCVList
- : the list of CATIConfigurableObjects
- oTerminalLinkable
- : the object real filterable
- oTerminalCV
- : the object real filterable associated CATIConfigurableObject
- Returns:
- : - S_OK if all is correct
- E_FAIL if an error occured
- S_FALSE if one of the CATIConfigurableObjects was NULL
o GetDomainList
-
Get the list of all defined domains ( Engineering, Manufacturing...).
- Parameters:
-
- oDomainList
- List of defined domain names.
- iValue
-
Legal Values: The legal values for this are as follows;
- TRANSLATED : Return translated string (domain name from NLS)
- UNTRANSLATED : Return un-translated string (domain name in English)
o GetEffectivityByIdent
public virtual HRESULT GetEffectivityByIdent( | const SEQUENCE(octet)& | iId, |
| CATICfgModification_var& | oEff) const = 0 |
-
Retrieve an Effectivity by its Identifier.
- Parameters:
-
- iId
- Effectivity (Modification) 's identifier.
- oEff
- Retrieved Effectivity.
o GetErrorMsg
public virtual void GetErrorMsg( | int& | oErrorNumber, |
| CATUnicodeString& | oErrorMsg) const = 0 |
-
Get error Message.
- Parameters:
-
- oErrorNumber
- Error Number.
- oErrorMsg
- Error Message.
o GetFullSpecName
-
Build the full name of a specification from for Category Name, and Spec name.
- Parameters:
-
- iCatName
- Category name.
- iSpecName
- Specification Name.
- oFullname
- Category's Full name. The fomat is "CategoryName.SpecName"
o GetListOfFilters
public virtual HRESULT GetListOfFilters( | CATListValCATICfgFilter_var& | oFilterList) const = 0 |
-
Get every filters defined in the active session.
- Parameters:
-
- oFilterList
- List of Filters present in memory.
o GetRealFilterableObject
public virtual HRESULT GetRealFilterableObject( | const CATILinkableObject_var& | iObj, |
| CATILinkableObject_var& | oRealObj, |
| CATIConfigurableObject_var& | oRealObjCV) = 0 |
-
Retrieves the object handling the effectivity of a filterable object (typically an Item Instance).
- Parameters:
-
- iObj
- : The filterable object.
- oRealObj
- : The linkable object handling the effectivity.
- oRealObjCV
- : The configurable object of oRealObj.
o GetStringEffectivity
-
Retrieve String Effectivity by its Unique CATILinkableObject.
- Parameters:
-
- iObj
- CATILinkableObject object to inspect.
- oCVList
- Retrieved Lists of configurable objects.
- oEffList
- Retrieved Lists of Effectivity.
o GetStringEffectivity
-
Retrieve String Effectivity by its Unique CATILinkableObject.
- Parameters:
-
- iObj
- CATILinkableObject object to inspect.
- oCVList
- Retrieved Lists of configurable objects.
- oEffList
- Retrieved Lists of Effectivity.
- iDomain
- Name of the Domain ( Engineering, Manufacturing...).
- iStatus
- Name of the State ( WIP, Approved ..).
o IsComputedEffectivityNull
public virtual HRESULT IsComputedEffectivityNull( | const CATILinkableObject_var& | iObj, |
| int& | oResolutionStatus)const = 0 |
-
Test if the Computed Effectivity is null
- Parameters:
-
- iObj
- : the object (ItemInstance) symbolic link
- oResolutionStatus
- : result flag to be checked against ResolutionStatus
- Returns:
- : - S_OK if all is correct
- E_FAIL if an error occured
o PopInfo
-
Retrieve the error messages pushed
- Parameters:
-
- oErrMsg
- The error message
o QueryAllConfigurable
-
Retrieve all Configurables.
- Parameters:
-
- oObj
- Retrieved List of Configurables.
o QueryAllConfigurableObject
-
Retrieve all configurable objects
- Parameters:
-
- oList
- List of Retrieved Configurable Objects.
o QueryAllModHistory
-
Query all ModHistory
o QueryAllVariabilitySpace
public virtual HRESULT QueryAllVariabilitySpace( | CATListValCATICfgVariabilitySpace_var& | out_List) const = 0 |
-
Retrieve all Variability Space Objects.
- Parameters:
-
- out_List
- List of Retrieved VariabilitySpace Objects.
o QueryConfigHandler
-
Query Config Handler.
- Parameters:
-
- iAttrValue
- Contains the attribute's value.
- iAttrName
- Atribute's Name.
iAttrValue works in pair with Attrname.
Possible Value for AttrName are : ID, DESCRIPTION, STATUS, OWNER,ALL.
and correponding types of iAttrValue are: CATUnicodeString, CATUnicodeString, CATUnicodeString, Sequence octet,none.
- iOp
- Query Operator.
Legal Values : IsEqual, IsLike.
- olist
- Retrieved List of Config handlers.
o QueryConfigHandlerForCO
-
Query Config Handler(s) on a Configurable Object.
- Parameters:
-
- iAttrValue
- Contains the attribute's value.
- iAttrName
- Atribute's Name.
iAttrValue works in pair with Attrname.
Possible Value for AttrName are : ID, DESCRIPTION, STATUS, OWNER,ALL.
and correponding types of iAttrValue are: CATUnicodeString, CATUnicodeString, CATUnicodeString, Sequence octet,none.
- iOp
- Query Operator.
Legal Values : IsEqual, IsLike.
- iCfgObj
- COnfigurable Object to inspect.
- olist
- Retrieved List of Config handlers.
o QueryConfigurableByObject
public virtual HRESULT QueryConfigurableByObject( | const SEQUENCE(octet)& | iUuid, |
| CATIConfigurable_var& | oObj) =0 |
-
Retrieve Configurable by its Unique Identifier.
- Parameters:
-
- iId
- Configurable's UUID.
- oObj
- Retrieved Configurable.
o QueryConfigurableObject
-
Retrieve Configurable Object carried by an object, its name being known.
- Parameters:
-
- iObj
- Identifier of the object to search.
- iName
- Name of Configurable Object to search.
- oList
- List of retrieved Configurable Objects.
o QueryConfigurableObject
-
Retrieve Configurable Object carried by an object, its name being known.
- Parameters:
-
- iObjectUID
- Identifier of the object to search.
- iName
- Name of Configurable Object to search.
- oList
- List of retrieved Configurable Objects.
o QueryConfigurableObjectByName
-
Retrieve Configurable Objects by name.
- Parameters:
-
- iOp
- "QueryOperator", referring to the type SQL order to be executed.
Legal Values :IsEqual, IsLike.
- iName
- Name of Configurable Object to search.
- oList
- List of Retrieved Configurable Objects.
o QueryConfigurableObjectByObject
-
Retrieve Configurable Objects carried by an object.
- Parameters:
-
- iObj
- Identifier of the object to search.
- oList
- List of Retrieved Configurable Objects.
o QueryConfigurableObjectByObject
-
Retrieve Configurable Objects carried by an object.
- Parameters:
-
- iObjectUID
- Identifier of the object to search.
- oList
- List of Retrieved Configurable Objects.
o QueryEffValByObject
public virtual HRESULT QueryEffValByObject( | const CORBAAny& | iUuid, |
| CATListOfCATICfgEffVal_var& | oList) = 0 |
-
Query an EffVal by object (UUID).
- Parameters:
-
- inUID
- The UUID of the Object to inspect.
- oList
- List Of Effval carried by this object.
o QueryEffectivities
-
Retrieve all effectivities pointing to a Filterable Object.
- Parameters:
-
- iUUID
- Filterable object's Identifier
- oList
- List of Effectivities retrieved.
o QueryEffectivitiesByCO
-
Retrieve all effectivities belonging to a Configurable Object and pointing to a filterable Object.
- Parameters:
-
- iUUID
- Filterable Object's Identifier.
A filterable Object can be an Item Instance, a Manufacturing instance, an inter-process link ...
- oList
- List of Effectivities retrieved.
o QueryEffectivitiesByName
-
Query Effectivities knowing their name.
- Parameters:
-
- Name
- Name of the effectivity to look for.
- allMods
- List of Modification (effectivities ) retrieved.
o QueryMileStoneByName
-
Query MileStones with a given name.
- Parameters:
-
- inName
- Input Name.
- outMileStone
- Retrieved MileStone.
o QueryModContainerByDescription
public virtual HRESULT QueryModContainerByDescription( | const CATUnicodeString& | iDescription, |
| CATListValCATICfgModContainer_var& | oModContainerList)const = 0 |
-
Retrieves a list of Modification Containers according to their description attribute.
The Modification Containers returned have their description strictly equal (regardless of
the case sensitiveness however) to the search criterion specified.
- Parameters:
-
- iDescription
- : the search criterion
- oModContainerList
- : the list of Modification Containers which description equals the the iDescription parameter.
- Returns:
- : - S_OK if all is correct
- E_FAIL if an error occured
o QueryModHistoryByObject
-
Query all ModHistory by Object
- Parameters:
-
- iObj
- : The object related to the history
- oList
- : The list given in output
- optional
- iPred
- optional
- iAttributeToSort
o QueryModificationListByNameList
-
Query Modification from their name.
- Parameters:
-
- iNameList
- modification name list
- olist
- Retrieved List of Modification.
o QueryNormalValuesByMileStoneName
-
Query Normal values using a given MileStone.
- Parameters:
-
- inMileStoneName
- Input MileStone.
- oList
- List of Retrieved Normal Values.
o QueryProductType
public virtual HRESULT QueryProductType( | CORBAAny& | iAttrValue, |
| const CATUnicodeString& | iAttrName, |
| CATICfgManager::QueryOperator | iOp, |
| CATListOfCATICfgProductType_var& | oList)=0 |
-
Query ProductTypes from known attibute. - Pavan
- Parameters:
-
- iAttrValue
- Contains the attribute's values.
- iAttrName
- Atribute's Name.
iAttrValue works in pair with Attrname.
Possible Value for AttrName are : VNAME, C509_ALIAS, UID,ALL.
and correponding types of iAttrValue are : String, String, Sequence octet, none
- iOp
- Query Operator.
Legal Values : IsEqual, IsLike.
- oList
- Retrieved List of ProductTypes.
- Returns:
- An HRESULT
Legal values:
- S_OK
- The objects are successfully retrieved
- S_FALSE
- Query succeeded but no Product Types that satsify the criteria
- E_FAIL
- Failed to Query
o QueryProgramByName
-
Query Program with a given name.
- Parameters:
-
- inName
- Input Name.
- outProgram
- Retrieved Program.
o QuerySimpleSpec
-
Query Simple Specifications from known attibute.
- Parameters:
-
- iAttrValue
- Contains the attribute's values.
- iAttrName
- Atribute's Name.
iAttrValue works in pair with Attrname.
Possible Value for AttrName are : ID, DESCRIPTION, UID, SPECEXCLU, MANDATORY,ALL.
and correponding types of iAttrValue are : String, String, Sequence octet, none, none,none.
- iOp
- Query Operator.
Legal Values : IsEqual, IsLike.
- olist
- Retrieved List of Simple Specifications.
o QuerySimpleSpecForCategory
-
Query Simple Specifications from known attibute on a given Specification Category.
- Parameters:
-
- iAttrValue
- Contains the attribute's value.
- iAttrName
- Atribute's Name.
iAttrValue works in pair with Attrname.
Possible Value for AttrName are : ID, DESCRIPTION, UID, SPECEXCLU, MANDATORY,ALL.
and correponding types of iAttrValue are : String, String, Sequence octet, none, none,none.
- iOp
- Query Operator.
Legal Values : IsEqual, IsLike.
- ICfgSpecCategory
- Spec Category to search.
- olist
- Retrieved List of Simple Specifications.
o QuerySimpleSpecList
-
Query Simple Specifications from their full name.
- Parameters:
-
- iSpecsFullName
- Specs full name list - a full name form is "Category_name|Spec_name"
- olist
- Retrieved List of Simple Specifications.
o QuerySpecCategories
public virtual HRESULT QuerySpecCategories( | CORBAAny& | iAttrValue, |
| const CATUnicodeString& | iAttrName, |
| CATICfgManager::QueryOperator | iOp, |
| CATListOfCATICfgSpecCategory_var& | oList) const=0 |
-
Query Specification Categories from known attibute.
- Parameters:
-
- iAttrValue
- Contains the attribute's values.
- iAttrName
- Atribute's Name.
iAttrValue works in pair with Attrname.
Possible Value for AttrName are : ID, DESCRIPTION, UID, SPECEXCLU, MANDATORY,ALL.
and correponding types of iAttrValue are : String, String, Sequence octet, none, none,none.
- iOp
- Query Operator.
Legal Values : IsEqual, IsLike.
- oList
- Retrieved List of SpecCategories.
o QueryVariabilitySpaceByName
public virtual HRESULT QueryVariabilitySpaceByName( | const CATUnicodeString& | in_Name, |
| CATICfgVariabilitySpace_var& | out_VariabilitySpace) const = 0 |
-
Retrieve a Variability Space Object with a given name if exist.
- Parameters:
-
- in_Name
- Input Name.
- out_VariabilitySpace
- Retrieved VariabilitySpace.
o RemoveConfigHandler
public virtual HRESULT RemoveConfigHandler( | CATIConfigHandler_var& | iConfigHandler) = 0 |
-
Remove a Config Handler.
o RemoveConfigurable
public virtual HRESULT RemoveConfigurable( | CATIConfigurable_var& | oCfgable)=0 |
-
Destroy Configurable, and all Configurable Object and Effectivities associated to it.
o RemoveSpecCategory
public virtual HRESULT RemoveSpecCategory( | CATICfgSpecCategory_var& | iSpecCat) = 0 |
-
Delete a Spec Category.
- Parameters:
-
- iSpecCat
- The Spec Category to Delete.
o RetrieveFilter
public virtual HRESULT RetrieveFilter( | const SEQUENCE(octet)& | iUuid, |
| CATICfgFilter_var& | oFilter)const = 0 |
-
Retrieve a Configuration Filter according to its Symbolic Link.
- Parameters:
-
- iUuid
- The filter Symbolic Link
- oFilter
- Retrieved Filter.
- Returns:
- : - S_OK: filter successfully retrieved - E_NOINTERFACE: no filter retrieved for the specified Symbolic Link
- E_FAIL: an error occured
o TransferMod
public virtual HRESULT TransferMod( | const CATILinkableObject_var& | iObj, |
| const CATICfgModification_var& | iReplaced, |
| const CATICfgModification_var& | iReplacing, |
| const CATListOfInt& | iOperations, |
| CATBoolean | iSimul | = FALSE, |
| CATBoolean | iEvent | = TRUE) const = 0 |
-
Method to transfer a modification used within an object's effectivity to another action.
- Parameters:
-
- iObj
- The filterable object.
- iReplaced
- The modification to replace by iReplacing.
- iReplacing
- The modification replacing iReplaced.
- iOperations
- List of operations to select which operations where a replace of modification is needed.
- iSimul
- Optional argument to simulate the operation only.
- iEvent
- Optional argument to trigger an event when transfer is not possible.
o TransferModWithAction
-
Method to transfer a modification linked to Action or ECO.
- Parameters:
-
- pCurrentMod
- The mod which is going to be transferred
- iUser
- The new User
- iOrgnization
- The new Orgnization
- iProject
- The new Project
- iSendEmail
- To decide whether to send mail or not
- iDescription
- Description about the transfer
o WhereConfigHandlerUsed
-
Query Config Handler(s) "Children" or "Brothers" of a given Config Handler.
- Parameters:
-
- iTheConfigHandler
- Input ConfigHandler.
- iListName
-
Legal Values : CHILDREN, BROTHER.
- olist
- Retrieved List of Config handlers.
o WhereNormalValueUsed
-
Find all the modifications and Config Handlers using a Normal Value.
Role : Useful for debug or error messages display.
- Parameters:
-
- iTheNV
- Input Normal Value.
- oModifList
- List of Modifications.
- oCfgHandlerList
- List of Config Handlers
Enumerated Types
o ComputedEffectivityStatus
-
enum ComputedEffectivityStatus {
ValidEff,
NullEff,
Unresolved
}
Enum defined to identify various states of a computed effectivity.
- Parameters:
-
- ValidEff
- Computed effectivity is a valid effectivity
- NullEff
- Computed effectivity is null
- Unresolved
- Computed effectivity is not defined i.e, the Add operation is not resolved.
o FilterMode
-
enum FilterMode {
Default,
Filter150
}
Enumeration
o Operations
-
enum Operations {
Added,
Cut,
Replaced,
Replacing,
Moved,
Moving,
Extended
}
o QueryOperator
-
enum QueryOperator {
IsEqual,
IsLike
}
Enumeration
o ResolutionStatus
-
enum ResolutionStatus {
AllResolved,
IncompleteContribution,
AtLeastOneParentUnresolved,
ObjectUnconfigured,
ObjectUnresolved,
NoContribution,
LonelyObject,
ComputedEffectivityAlwaysTrue
}
This object is included in the file: CATICfgManager.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces