All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Interface CATIOptConstraint

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

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


interface CATIOptConstraint

Interface encapsulating an optimization constraint.

Technically speaking, a constraint is a kwe expressionnal relation (answers to CATICkeRelationExp) and is basically a check


Method Index


o GetBound()
Returns the right hand side value of the constraint.
o GetConstraintType()
Returns the constraint type.
o GetDistance()
Returns the necessary distance to respect the constraint.
o GetDistanceParameter()
Returns the parameter valuated with the necessary distance to respect the constraint.
o GetLHSValue()
Returns the left hand side value of the constraint.
o GetMagnitude()
Returns the magnitude of the constraint.
o GetPrecision()
Gets the precision for equality constraints.
o GetPriority()
Returns the priority of the constraint.
o GetWeight()
Returns the weight of the constraint.
o IsRespected()
Indicates if the constraint is respected.
o SetPrecision(double)
Sets the precision for equality constraints.
o SetPriority(int)
Sets the priority of the constraint.
o SetWeight(double)
Sets the weight of the constraint.

Enumerated Type Index


o ConstraintType
Constraint type

Methods


o GetBound
public virtual double GetBound()const = 0
Returns the right hand side value of the constraint.
Returns:
the right side member of the constraint (for example x + y > 7mm. The method returns 0.007 (7mm in mks))
o GetConstraintType
public virtual CATIOptConstraint::ConstraintType GetConstraintType()const = 0
Returns the constraint type.
Returns:
a Constraint Type
o GetDistance
public virtual double GetDistance()const = 0
Returns the necessary distance to respect the constraint.
Returns:
the distance to constraint respect (for example x > 7mm with x = 3mm. The method returns 0.004 (4mm in mks))
o GetDistanceParameter
public virtual CATICkeParm_var GetDistanceParameter()= 0
Returns the parameter valuated with the necessary distance to respect the constraint.
Returns:
a parameter aggregated to the constraint containing the distance value
o GetLHSValue
public virtual double GetLHSValue()const = 0
Returns the left hand side value of the constraint.
Returns:
the value of the left hand side of the constraint (for example x + y > 7 The method returns 11 if x = 1 and y = 10;
o GetMagnitude
public virtual CATICkeMagnitude_var GetMagnitude()const = 0
Returns the magnitude of the constraint.
Returns:
the magnitude of the constraint.
o GetPrecision
public virtual double GetPrecision()const = 0
Gets the precision for equality constraints. the method IsRespected will return 1 if the distance to constraint respect is less than the precision
o GetPriority
public virtual unsigned int GetPriority()const = 0
Returns the priority of the constraint.
o GetWeight
public virtual double GetWeight()const = 0
Returns the weight of the constraint.
o IsRespected
public virtual int IsRespected()const = 0
Indicates if the constraint is respected.
Returns:
1 if the constraint is respected, 0 else (see SetPrecision and GetPrecision)
o SetPrecision
public virtual void SetPrecision(double mksPrecision) = 0
Sets the precision for equality constraints. The method IsRespected will return 1 if the distance to constraint respect is less than the precision
o SetPriority
public virtual void SetPriority(int iPriority) = 0
Sets the priority of the constraint. The priority is used to give more/less importance to the constraint during the optimization results classification (results exploitation). The priority is an integer number.
o SetWeight
public virtual void SetWeight(double iWeight) = 0
Sets the weight of the constraint. The weight is used to give more/less importance to the constraint during the optimization computations (algorithms run). The weight is a double number.

Enumerated Types


o ConstraintType
enum ConstraintType {
  UNKNOWN,
  EQ,
  GT,
  GE,
  LT,
  LE,
  NE
}
Constraint type

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

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