Modelib: Référence de la classe Modelib::NumVar

Page principale | Liste des namespaces | Hiérarchie des classes | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de namespace | Membres de classe | Membres de fichier

# Référence de la classe Modelib::NumVar

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

`#include <NumVar.h>`

Graphe d'héritage de Modelib::NumVar:

[légende]
Graphe de collaboration de Modelib::NumVar:

[légende]
Liste de tous les membres

## Fonctions membres publiques
| 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)
NumVar & | operator= (const NumVar &_n)
VarId | GetVarId () const
Model * | GetModel () 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)
| ~NumVar ()
## Attributs protégés
VarId | varId
| identifiant de variable
Model * | modele
| 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:

- un modele
- une borne inférieure
- une borne supérieure
- un type
- un nom Elle peut aussi être construite par un identifiant et un pointeur sur un modele.
  Ce constructeur est utilisé surtout pour récréer des variables de Type NumVar a partir d' un identifiant uniquement.
  Elle a trois classes héritées qui premettent juste la simplifiction d'écriture

Définition à la ligne 60 du fichier NumVar.h.

## Documentation des contructeurs et destructeur

Modelib::NumVar::NumVar | ( |  | ) | `[inline]`

| Constructeur par défaut Définition à la ligne 67 du fichier NumVar.h. Référencé par NumVar().

Modelib::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 Définition à la ligne 58 du fichier NumVar.cpp.

Modelib::NumVar::NumVar | ( | Model & | _modele,
|  | MuteVar::VarType | _type = `MuteVar::FLOAT`,
|  | const std::string & | _nom = `"unknow"`
| ) | `[inline]`

| Définition à la ligne 75 du fichier NumVar.h. Références Modelib::MuteVar::FLOAT, Modelib::Infinity, et NumVar(). Voici le graphe d'appel pour cette fonction:

Modelib::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 Définition à la ligne 71 du fichier NumVar.cpp. Références Modelib::defaultGetName, Modelib::Model::GetName(), modele, et varId. Voici le graphe d'appel pour cette fonction:

Modelib::NumVar::NumVar | ( | const NumVar & | _n | ) | `[inline]`

| Constructeur de recopie Définition à la ligne 85 du fichier NumVar.h.

Modelib::NumVar::~NumVar | ( |  | ) | `[inline]`

| Définition à la ligne 127 du fichier NumVar.h.

## Documentation des fonctions membres

float Modelib::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 Définition à la ligne 146 du fichier NumVar.cpp. Références Modelib::Model::GetMuteVarLB(), modele, et varId. Référencé par Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

Model* Modelib::NumVar::GetModel | ( |  | ) | const`[inline]`

| Geter du modèle Renvoie: Un pointeur sur le Model où est définie la varaible. Définition à la ligne 104 du fichier NumVar.h. Références modele. Référencé par Modelib::Model::AddExpr(), Modelib::Model::AddToConstraint(), Modelib::operator==(), Modelib::Expr::Simplify(), et Modelib::Model::SurchargeMPSFlux().

std::string Modelib::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 Définition à la ligne 114 du fichier NumVar.cpp. Références Modelib::Model::GetName(), modele, Modelib::noModel, et varId. Référencé par Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

MuteVar::VarType Modelib::NumVar::GetType | ( |  | ) | const

| Geter du type de la variable Renvoie: Le type de la variable Voir également: Model::GetMuteVar MuteVar::GetType Définition à la ligne 247 du fichier NumVar.cpp. Références Modelib::MuteVar::FLOAT, Modelib::Model::GetMuteVar(), Modelib::MuteVar::GetType(), modele, et varId. Référencé par Modelib::export_NumVar(), Modelib::Expr::Expr(), et Modelib::Expr::Simplify(). Voici le graphe d'appel pour cette fonction:

float Modelib::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 Définition à la ligne 171 du fichier NumVar.cpp. Références Modelib::Model::GetMuteVarUB(), modele, et varId. Référencé par Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

float Modelib::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 Définition à la ligne 95 du fichier NumVar.cpp. Références Modelib::Model::GetMuteVar(), Modelib::MuteVar::GetValue(), modele, et varId. Référencé par Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

VarId Modelib::NumVar::GetVarId | ( |  | ) | const`[inline]`

| Geter de l'identifiant de variable Renvoie: L'identifiant de variable sous le format VarId. Définition à la ligne 99 du fichier NumVar.h. Références varId. Référencé par Modelib::Model::AddExpr(), Modelib::Model::AddToConstraint(), Modelib::export_NumVar(), Modelib::Comparaison::operator()(), Modelib::operator==(), Modelib::Model::RelaxBool2Float(), Modelib::Model::RelaxInt2Float(), et Modelib::Model::SurchargeMPSFlux().

bool Modelib::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 Définition à la ligne 196 du fichier NumVar.cpp. Références Modelib::Model::GetMuteVar(), Modelib::MuteVar::IsLowerBoundStrict(), modele, et varId. Référencé par Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

bool Modelib::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 Définition à la ligne 221 du fichier NumVar.cpp. Références Modelib::Model::GetMuteVar(), Modelib::MuteVar::IsUpperBoundStrict(), modele, et varId. Référencé par Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

NumVar& Modelib::NumVar::operator= | ( | const NumVar & | _n | ) | `[inline]`

| Opérateur de recopie Définition à la ligne 88 du fichier NumVar.h. Références modele, et varId.

void Modelib::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 Définition à la ligne 158 du fichier NumVar.cpp. Références modele, Modelib::Model::SetMuteVarLB(), et varId. Référencé par Modelib::Model::Add(), et Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

void Modelib::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 Définition à la ligne 208 du fichier NumVar.cpp. Références modele, Modelib::Model::SetMuteVarLBStrict(), et varId. Référencé par Modelib::Model::Add(), et Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

void Modelib::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 Définition à la ligne 130 du fichier NumVar.cpp. Références modele, Modelib::Model::SetName(), et varId. Référencé par Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

void Modelib::NumVar::SetType | ( | MuteVar::VarType | _type | ) |

  | Seter du type de la variable Paramètres:
  | Le | type que doit prendre la variable
Voir également: Model::SetType Définition à la ligne 259 du fichier NumVar.cpp. Références modele, Modelib::Model::SetType(), et varId. Référencé par Modelib::export_NumVar(), et Modelib::FichierProbleme::operator>>(). Voici le graphe d'appel pour cette fonction:

void Modelib::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 Définition à la ligne 183 du fichier NumVar.cpp. Références modele, Modelib::Model::SetMuteVarUB(), et varId. Référencé par Modelib::Model::Add(), et Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

void Modelib::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 Définition à la ligne 233 du fichier NumVar.cpp. Références modele, Modelib::Model::SetMuteVarUBStrict(), et varId. Référencé par Modelib::Model::Add(), et Modelib::export_NumVar(). Voici le graphe d'appel pour cette fonction:

## Documentation des données membres

Model* Modelib::NumVar::modele`[protected]`

| modèle de définition Définition à la ligne 64 du fichier NumVar.h. Référencé par GetLowerBound(), GetModel(), GetName(), GetType(), GetUpperBound(), GetValue(), IsLowerBoundStrict(), IsUpperBoundStrict(), NumVar(), operator=(), SetLowerBound(), SetLowerBoundStrict(), SetName(), SetType(), SetUpperBound(), et SetUpperBoundStrict().

VarId Modelib::NumVar::varId`[protected]`

| identifiant de variable Définition à la ligne 63 du fichier NumVar.h. Référencé par GetLowerBound(), GetName(), GetType(), GetUpperBound(), GetValue(), GetVarId(), IsLowerBoundStrict(), IsUpperBoundStrict(), NumVar(), operator=(), SetLowerBound(), SetLowerBoundStrict(), SetName(), SetType(), SetUpperBound(), et SetUpperBoundStrict().

La documentation de cette classe a été générée à partir des fichiers suivants:

- NumVar.h
- NumVar.cpp