All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATICfgSpecANDExpression

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

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


interface CATICfgSpecANDExpression

Class to manage operations on SpecANDExpressions.
Role: A SpecANDexpression is a logical expression constituted of one or several Signed Specifications. The Signed Specifications are linked with the AND logical operator. A SpecANDexpression is used in the context of Configuration. It serves to give an effectivitity to a part Instance, based on specifications.

See also:
CATICfgSpecORExpression, CATICfgSignedSpec


Method Index


o AddListOfSignedSpec(CATListValCATICfgSignedSpec_var&)
Add a list of Signed Specs to a SpecANDexpression.
o AddSignedSpec(CATICfgSignedSpec_var&)
Add a Signed Specific to a SpecANDExpression.
o AddSpecANDExp(CATICfgSpecANDExpression_var&)
Add a SpecANDExpression to a SpecANDExpression(Concatenation).
o CopySpecANDExp(CATICfgSpecANDExpression_var&)
Copy a SpecANDExpression
o Dump()
Dump informations on a SpecANDExpression to STDOUT.
o EmptySpecANDExp()
Remove all Signed Specs from a SpecANDExpression.
o GetAsXmlString(CATUnicodeString&)
Get a XML String representing a SpecANDExpression
o GetListNV(CATListValCATICfgNormalValue_var&)
Convert a SpecANDExpression to a list of Normal Values.
o GetListOfSignedSpec(CATListValCATICfgSignedSpec_var&)
Get the List of Signed Spec composing a SpecANDExpression.
o GetNbOfSignedSpec()
Get the number of Signed Specs composing a SpecANDExpression.
o IsIncludedIn(CATICfgSpecANDExpression_var&)
Inclusion test on two SpecANDExpressions.

Methods


o AddListOfSignedSpec
public virtual HRESULT AddListOfSignedSpec(CATListValCATICfgSignedSpec_var& iListSpec) =0
Add a list of Signed Specs to a SpecANDexpression.
Returns:
An HRESULT value.
Legal values: S_OK : iListSpec successfully added. E_FAIL : iListSpec is not compatible with "this" expression.
Parameters:
iListOfSpecs
The List of SignedSpecs.
o AddSignedSpec
public virtual HRESULT AddSignedSpec( const CATICfgSignedSpec_var& iSpec)= 0
Add a Signed Specific to a SpecANDExpression.
Returns:
An HRESULT value.
Legal values: S_OK : iSpec successfully added. E_FAIL : iSpec is not compatible with "this" expression.
Parameters:
iSpec
The Signed Specification to add.
o AddSpecANDExp
public virtual HRESULT AddSpecANDExp( const CATICfgSpecANDExpression_var& iSpecANDExp) = 0
Add a SpecANDExpression to a SpecANDExpression(Concatenation).
Returns:
An HRESULT value.
Legal values: S_OK : iSpecANDExpr successfully added. E_FAIL : iSpecANDExp is not compatible with "this" expression.
Parameters:
iSpecANDExp
The SpecANDExpression to add.
o CopySpecANDExp
public virtual HRESULT CopySpecANDExp(CATICfgSpecANDExpression_var& oSpecANDExpression) =0
Copy a SpecANDExpression
Returns:
An HRESULT Value.
Parameters:
oSpecANDexpression
Copy of the SpecANDExpression.
o Dump
public virtual void Dump()const = 0
Dump informations on a SpecANDExpression to STDOUT.
o EmptySpecANDExp
public virtual void EmptySpecANDExp()= 0
Remove all Signed Specs from a SpecANDExpression.
o GetAsXmlString
public virtual HRESULT GetAsXmlString(CATUnicodeString& oEncodedString) const = 0
Get a XML String representing a SpecANDExpression
Returns:
A CATUnicideString in XML format.
o GetListNV
public virtual HRESULT GetListNV(CATListValCATICfgNormalValue_var& oListNV) const = 0
Convert a SpecANDExpression to a list of Normal Values.
Returns:
An HRESULT Value.
Parameters:
oListNV
List Of Normal Values
o GetListOfSignedSpec
public virtual void GetListOfSignedSpec(CATListValCATICfgSignedSpec_var& oListOfSpec) const = 0
Get the List of Signed Spec composing a SpecANDExpression.
Parameters:
oListOfSpecs
The List of SignedSpecs.
o GetNbOfSignedSpec
public virtual int GetNbOfSignedSpec()const = 0
Get the number of Signed Specs composing a SpecANDExpression.
Returns:
An integer value (int).
Parameters:
oNbVaLues
The number of Signed Specs.
o IsIncludedIn
public virtual HRESULT IsIncludedIn(CATICfgSpecANDExpression_var& iSpecANDExpression) = 0
Inclusion test on two SpecANDExpressions.
Returns:
An HRESULT Value.
Legal values: S_OK : "this" is included in iSpecANDExpression. S_FALSE : "this" is not included in iSpecANDExpression.
Parameters:
iSpecANDExpression
The SpecANDExpression with wich inclusion will be tested.
oListSpecNonIncluded
Contains non-included specifications. example: "this" = "SpecA and SpecD", "iSpecANDExpression"= "SpecA and SpecC and SpecB". Result: ret = S_FALSE, and "oListSpecNonIncluded" = "SpecD".

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

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