All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATICfgEffectivity

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

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


interface CATICfgEffectivity

Class to manage effectivity


Method Index


o AddEffectivity(CATICfgBasicEffectivity_var&)
Adds an effectivity to an ORExpression
o AddEffectivity(CATICfgEffectivity_var&)
Adds an effectivity to an Effectivity
o ComputeAND(CATICfgEffectivity_var&,CATListValCATICfgBasicEffectivity_var&)
Compute the AND-Operation between this Effectivity and a given input Effectivity.
o GetListOfEffectivities(CATListValCATICfgBasicEffectivity_var&)
Retrieves the Effectivities of an ORExpression
o RemoveEffectivity(CATICfgEffectivity_var&,CATListValCATICfgBasicEffectivity_var&)
Removes an Effectivity from an Effectivity

Enumerated Type Index


o Type
Supported types of effectivity 'All' is used in queries in order to specify you want to retrieve validated effectivities and modifications

Methods


o AddEffectivity
public virtual HRESULT AddEffectivity( const CATICfgBasicEffectivity_var& iEffectivity) = 0
Adds an effectivity to an ORExpression
Parameters:
iEffectivity
The effectivity to add.
o AddEffectivity
public virtual HRESULT AddEffectivity( const CATICfgEffectivity_var& iEffectivity)= 0
Adds an effectivity to an Effectivity
Parameters:
iEffectivity
The effectivity to add.
o ComputeAND
public virtual HRESULT ComputeAND( const CATICfgEffectivity_var& iEffectivity,
CATListValCATICfgBasicEffectivity_var& oResult) = 0
Compute the AND-Operation between this Effectivity and a given input Effectivity.
Parameters:
The
input Effectivity.
The
result of the AND-operation.
o GetListOfEffectivities
public virtual HRESULT GetListOfEffectivities(CATListValCATICfgBasicEffectivity_var& oList) const= 0
Retrieves the Effectivities of an ORExpression
Parameters:
oList
The effectivities.
o RemoveEffectivity
public virtual HRESULT RemoveEffectivity( const CATICfgEffectivity_var& iEffectivity,
CATListValCATICfgBasicEffectivity_var& oResult) = 0
Removes an Effectivity from an Effectivity
Parameters:
iEffectivity
The effectivity to remove.

Enumerated Types


o Type
enum Type {
  ValidatedEffectivity,
  Modification,
  SnapShot,
  All
}
Supported types of effectivity 'All' is used in queries in order to specify you want to retrieve validated effectivities and modifications

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

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