All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATICfgSignedSpec

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

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


interface CATICfgSignedSpec

Class to manage operations on Signed Specifications.
Role: A Signed Specification is composed of a simple specification and a sign, giving the information of which of these two assertions is true: (Spec) or (!Spec). A Signed Spec is used in the context of Configuration. It serves to give an effectivity to a part Instance, the same way ranges or dates do.

See also:
CATICfgEffectivity


Method Index


o CompareSignedSpec(CATICfgSignedSpec_var&)
Comparaison between two Signed Specs.
o CopyMe(CATICfgSignedSpec_var&)
Duplicate a Signed Spec.
o Dump()
Dump informations on Signed spec to STDOUT.
o GetAsString()
String rep.
o GetAsXmlString(CATUnicodeString&)
Get a string representing the Signed Spec in XML format.
o GetFullName(CATUnicodeString&)
Get full Signed Spec's Name.
o GetName(CATUnicodeString&)
Get Signed Spec's Name.
o GetSign()
Get sign of a Signed Spec.
o GetSpec(CATICfgSimpleSpecification_var&)
Get Simple Specification composing Signed Specification.
o IsTrue(CATListValCATICfgNormalValue_var&)
Find if a SignedSpec matches at least one criteria.
o SearchInList(CATListValCATICfgSignedSpec_var&)
Search Signed Spec in List of Signed Spec.
o SetSign(int)
Set sign of a Signed Spec.
o SetSpec(CATICfgSimpleSpecification_var&)
Get Simple Specification composing Signed Specification.

Methods


o CompareSignedSpec
public virtual int CompareSignedSpec( const CATICfgSignedSpec_var& iSignedSpec) = 0
Comparaison between two Signed Specs.
Returns:
An integer.
Legal values: 0 means EQUAL. 1 means DIFFERENT.
Parameters:
iSignedSpec
Signed Spec to compare with "this".
o CopyMe
public virtual HRESULT CopyMe(CATICfgSignedSpec_var& oSpec) = 0
Duplicate a Signed Spec.
Parameters:
oSpec
The copy of the Signed Spec.
o Dump
public virtual void Dump()const = 0
Dump informations on Signed spec to STDOUT.
o GetAsString
public virtual CATUnicodeString GetAsString()const = 0
String rep.
o GetAsXmlString
public virtual HRESULT GetAsXmlString(CATUnicodeString& oEncodedString) = 0
Get a string representing the Signed Spec in XML format.
Parameters:
oEncodedString
XML string retrieved.
o GetFullName
public virtual HRESULT GetFullName(CATUnicodeString& oName) const = 0
Get full Signed Spec's Name.
Parameters:
oName
Signed Spec'Name, given with the format "CategoryName.SpecName".
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName) const = 0
Get Signed Spec's Name.
Parameters:
oName
Signed Spec'Name, given alone.
o GetSign
public virtual int GetSign()const = 0
Get sign of a Signed Spec.
Returns:
An integer.
Legal values: 1 counts for positive sign. Any other value counts for negative sign.
o GetSpec
public virtual void GetSpec(CATICfgSimpleSpecification_var& oSpec) const = 0
Get Simple Specification composing Signed Specification.
Parameters:
oSpec
The simple Specification retrieved.
o IsTrue
public virtual HRESULT IsTrue( const CATListValCATICfgNormalValue_var& iList) const = 0
Find if a SignedSpec matches at least one criteria.
Returns:
S_OK : The SignedSpec matches one criteria S_FALSE : The SignedSpec matches no criteria E_FAIL : Error
Parameters:
iList
List of criteria.
o SearchInList
public virtual int SearchInList( const CATListValCATICfgSignedSpec_var& iList) = 0
Search Signed Spec in List of Signed Spec.
Returns:
An integer.
Legal values: 0 means EQUAL. 1 means DIFFERENT.
Parameters:
iSignedSpec
Signed Spec to search.
o SetSign
public virtual void SetSign( const int i) = 0
Set sign of a Signed Spec.
Parameters:
i
Sign to set.
Legal values: 1 counts for positive sign. Any other value counts for negative sign.
o SetSpec
public virtual void SetSpec( const CATICfgSimpleSpecification_var& iSpec) = 0
Get Simple Specification composing Signed Specification.
Parameters:
iSpec
The simple Specification to set.

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

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