Page principale | Hiérarchie des classes | Liste des composants | Liste des fichiers | Composants

Référence de la classe NumVar

Classe représentant des variables rattachées à un modèle. Plus de détails...

#include <NumVar.h>

Graphe d'héritage de la classe NumVar

BoolVar FloatVar IntVar Liste de tous les membres

Membres publics

 NumVar ()
 NumVar (Model &_modele, float _lb=0, float _ub=Infinity, MuteVar::VarType _type=MuteVar::FLOAT, const std::string &_nom="unknow")
 NumVar (Model &_modele, MuteVar::VarType _type=MuteVar::FLOAT, const std::string &_nom="unknow")
 NumVar (const Model *, VarId)
 NumVar (const NumVar &_n)
NumVaroperator= (const NumVar &_n)
VarId GetVarId () const
ModelGetModel () const
float GetValue () const
std::string GetName () const
void SetName (const std::string &)
float GetLowerBound () const
void SetLowerBound (float _value)
float GetUpperBound () const
void SetUpperBound (float _value)
bool IsLowerBoundStrict () const
void SetLowerBoundStrict (bool _value=true)
bool IsUpperBoundStrict () const
void SetUpperBoundStrict (bool _value=true)
MuteVar::VarType GetType () const
void SetType (MuteVar::VarType _type)

Attributs Protégés

VarId varId
 identifiant de variable

Modelmodele
 modèle de définition


Description détaillée

Classe représentant des variables rattachées à un modèle.

Le pointeur à été préféré à la référence car il premet la définition d'une variable neutre NumVar(), utile pour représenter les constantes dans les expressions par exemple.
La classe est normalisée car elle sera utilisée avec la STL.
Une variable "NumVar" est ainsi définie par constructeur par:


Documentation des contructeurs et destructeurs

NumVar::NumVar  )  [inline]
 

Constructeur par défaut

NumVar::NumVar Model _modele,
float  _lb = 0,
float  _ub = Infinity,
MuteVar::VarType  _type = MuteVar::FLOAT,
const std::string &  _nom = "unknow"
 

! Constructeur requierant un modele pour être utiliser. Facilite la lisibilité des déclarations de variables et permet de s'assurer que le modele existe et est valide.
Fait appel à la fonction AddVar de la classe Model qui est protégée au sein de Model. Ceci est possible car la classe NumVar est déclarée friend dans la classe Model. Ceci permet un controle de la déclaration de variable impossible si AddVar était publique.
Un test permet de detecter l'existence du modele mais pas sa validité.

Paramètres:
_Model modèle d'existence de la variable
_lb Value de borne inférieure
_ub Value de borne supérieure
_type Type de la variable
_nom nom de la variable
Voir également:
Model::AddVar

NumVar::NumVar const Model _modele,
VarId  _varId
 

Constructeur permettant de recréer une variable a partir d'un identifiant et d'un pointeur constant sur un modele.
Si le modele n'existe pas ou si l'identifiant ne represente rien alors la variable est neutre.

Voir également:
Model::GetName

NumVar::NumVar const NumVar _n  )  [inline]
 

Constructeur de recopie


Documentation des méthodes

float NumVar::GetLowerBound  )  const
 

Geter de la borne inférieure de la variable representée dans le modele par une MuteVar.

Renvoie:
float La value de la borne inférieure
Voir également:
Model::GetMuteVarLB

Model* NumVar::GetModel  )  const [inline]
 

Geter du modèle

Renvoie:
Un pointeur sur le Model où est définie la varaible.

std::string NumVar::GetName  )  const
 

Geter du nom associé à la variable representé dans le modele par un std::string.

Renvoie:
La nom associé à la varaible
Voir également:
Model::GetName

MuteVar::VarType NumVar::GetType  )  const
 

Geter du type de la variable

Renvoie:
Le type de la variable
Voir également:
Model::GetMuteVar MuteVar::GetType

float NumVar::GetUpperBound  )  const
 

Geter de la borne supérieure de la variable representée dans le modele par une MuteVar.

Renvoie:
float La value de la borne supérieure
Voir également:
Model::GetMuteVarUB

float NumVar::GetValue  )  const
 

Geter de la value de la variable representée dans le modele par une MuteVar.

Renvoie:
La value de varaible après résolution du problème
Voir également:
Model::GetMuteVar

VarId NumVar::GetVarId  )  const [inline]
 

Geter de l'identifiant de variable

Renvoie:
L'identifiant de variable sous le format VarId.

bool NumVar::IsLowerBoundStrict  )  const
 

Geter permettant de définir si la borne inférieure de la variable est stricte ou non

Renvoie:
true si la borne inférieure est stricte
Voir également:
Model::GetMuteVar MuteVar::IsLowerBoundStrict

bool NumVar::IsUpperBoundStrict  )  const
 

Geter permettant de définir si la borne supérieure de la variable est stricte ou non

Renvoie:
true si la borne supérieure est stricte
Voir également:
Model::GetMuteVar MuteVar::IsUpperBoundStrict

NumVar& NumVar::operator= const NumVar _n  )  [inline]
 

Opérateur de recopie

void NumVar::SetLowerBound float  _value  ) 
 

Seter de la borne inférieure de la variable representée dans le modele par une MuteVar.

Paramètres:
_value La value de la borne inférieure
Voir également:
Model::SetMuteVarLB

void NumVar::SetLowerBoundStrict bool  _value = true  ) 
 

Geter permettant de définir si la borne inférieure de la variable est stricte ou non

Paramètres:
_value= true si la borne inférieure doit être stricte
Voir également:
Model::SetMuteVarLBStrict

void NumVar::SetName const std::string &  name  ) 
 

Seter du nom associé à la variable representé dans le modele par un std::string.

Paramètres:
La nom associé à la varaible
Voir également:
Model::SetName

void NumVar::SetType MuteVar::VarType  _type  ) 
 

Seter du type de la variable

Paramètres:
Le type que doit prendre la variable
Voir également:
Model::SetType

void NumVar::SetUpperBound float  _value  ) 
 

Seter de la borne supérieure de la variable representée dans le modele par une MuteVar.

Paramètres:
_value La value de la borne supérieure
Voir également:
Model::SetMuteVarUB

void NumVar::SetUpperBoundStrict bool  _value = true  ) 
 

Geter permettant de définir si la borne supérieure de la variable est stricte ou non

Paramètres:
_value= true si la borne supérieure doit être stricte
Voir également:
Model::SetMuteVarUBStrict


La documentation associée à cette classe a été générée à partir des fichiers suivants :
Généré le Mon Jul 18 23:07:41 2005 pour Modelib par doxygen 1.3.6