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

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::MuteVar

Classe de base représentant les variables dans le modele. Plus de détails...

`#include <MuteVar.h>`

Graphe de collaboration de Modelib::MuteVar:

[légende]
Liste de tous les membres

## Types publics
enum | VarType { FLOAT = 0, INT, BOOL }
## Fonctions membres publiques
| MuteVar (MuteVar::VarType type=MuteVar::FLOAT, float _value=0.0f, float _lB=0.0f, float _uB=0.0f)
| MuteVar (const MuteVar &_mv)
MuteVar & | operator= (const MuteVar &_mv)
MuteVar & | operator= (float _value)
float | GetValue () const
float | GetLowerBound () const
float | GetUpperBound () const
bool | IsLowerBoundStrict () const
bool | IsUpperBoundStrict () const
VarType | GetType () const
void | SetType (MuteVar::VarType type)
void | SetLowerBound (float _value)
void | SetUpperBound (float _value)
void | SetIsLBStrict (bool _value=true)
void | SetIsUBStrict (bool _value=true)
bool | IsRelaxed () const
void | SetRelaxed (bool _isRelaxed=true)
| ~MuteVar ()
## Attributs privés
bool | isBool
| La variable est-elle booléenne?
bool | isInt
| La variable est-elle entière?
bool | isLBStrict
| La borne inférieure est-elle stricte?
bool | isUBStrict
| La borne supérieure est-elle stricte?
bool | isRelaxed
| La variable est elle relaxée en float?
float | value
| Value de la variable après résolution.
float | lowerBound
| Value de la borne inférieure.
float | upperBound
| Value de la borne inférieure.

## Description détaillée

Classe de base représentant les variables dans le modele.

Elle est composée en privé:

- de deux booléens "isBool" et "isInt" permettant de definir son type parmi VarType(economie de place)
- de deux booléens "isLBStrict" et "isUBStrict" permettant de definir si les bornes du domaine de définition de la variable sont ouvertes ou fermées
- d'un réel "value" stockant la value de la variable après résolution
- de deux réels "lowerBound" et "upperBound" délimitant le domaine de défintion de la variable

Définition à la ligne 47 du fichier MuteVar.h.

## Documentation des énumérations membres

enum Modelib::MuteVar::VarType

  | Valeurs énumérées:
  FLOAT |
  INT |
  BOOL |
Définition à la ligne 59 du fichier MuteVar.h.

## Documentation des contructeurs et destructeur

Modelib::MuteVar::MuteVar | ( | MuteVar::VarType | type = `MuteVar::FLOAT`,
|  | float | _value = `0.0f`,
|  | float | _lB = `0.0f`,
|  | float | _uB = `0.0f`
| ) | `[inline]`

| Contructeur de base et par défaut Définition à la ligne 62 du fichier MuteVar.h.

Modelib::MuteVar::MuteVar | ( | const MuteVar & | _mv | ) | `[inline]`

| Contructeur de recopie Définition à la ligne 72 du fichier MuteVar.h.

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

| Définition à la ligne 160 du fichier MuteVar.h.

## Documentation des fonctions membres

float Modelib::MuteVar::GetLowerBound | ( |  | ) | const`[inline]`

| Geter de la borne inférieure Renvoie: lowerBound Définition à la ligne 105 du fichier MuteVar.h. Références lowerBound.

VarType Modelib::MuteVar::GetType | ( |  | ) | const`[inline]`

| Geter du type de la variable Renvoie: Le type de la variable Définition à la ligne 122 du fichier MuteVar.h. Références BOOL, FLOAT, INT, isBool, et isInt. Référencé par Modelib::Model::AddVar(), et Modelib::NumVar::GetType().

float Modelib::MuteVar::GetUpperBound | ( |  | ) | const`[inline]`

| Geter de la borne supérieure Renvoie: upperBound Définition à la ligne 109 du fichier MuteVar.h. Références upperBound.

float Modelib::MuteVar::GetValue | ( |  | ) | const`[inline]`

| Geter de la value de la variable Renvoie: La value de la variable après résolution Définition à la ligne 101 du fichier MuteVar.h. Références value. Référencé par Modelib::Model::EvalConstraint(), et Modelib::NumVar::GetValue().

bool Modelib::MuteVar::IsLowerBoundStrict | ( |  | ) | const`[inline]`

| La borne inférieure est-elle stricte? Renvoie: isLBStrict Définition à la ligne 113 du fichier MuteVar.h. Références isLBStrict. Référencé par Modelib::NumVar::IsLowerBoundStrict().

bool Modelib::MuteVar::IsRelaxed | ( |  | ) | const`[inline]`

| Définition à la ligne 157 du fichier MuteVar.h. Références isRelaxed.

bool Modelib::MuteVar::IsUpperBoundStrict | ( |  | ) | const`[inline]`

| La borne supérieure est-elle stricte? Renvoie: isUBStrict Définition à la ligne 117 du fichier MuteVar.h. Références isUBStrict. Référencé par Modelib::NumVar::IsUpperBoundStrict().

MuteVar& Modelib::MuteVar::operator= | ( | float | _value | ) | `[inline]`

| Opérateur d'assignement Définition à la ligne 92 du fichier MuteVar.h. Références value.

MuteVar& Modelib::MuteVar::operator= | ( | const MuteVar & | _mv | ) | `[inline]`

| Opérateur de recopie Définition à la ligne 78 du fichier MuteVar.h. Références isBool, isInt, isLBStrict, isRelaxed, isUBStrict, lowerBound, upperBound, et value.

void Modelib::MuteVar::SetIsLBStrict | ( | bool | _value = `true` | ) | `[inline]`

  | Seter pour définir la borne inférieure strict Paramètres:
  | _value | la nouvelle value isLBStrict
Définition à la ligne 151 du fichier MuteVar.h. Références isLBStrict.

void Modelib::MuteVar::SetIsUBStrict | ( | bool | _value = `true` | ) | `[inline]`

  | Seter pour définir la borne supérieure strict Paramètres:
  | _value | la nouvelle value isUBStrict
Définition à la ligne 155 du fichier MuteVar.h. Références isUBStrict.

void Modelib::MuteVar::SetLowerBound | ( | float | _value | ) | `[inline]`

  | Seter de la borne inférieure Paramètres:
  | _value | la nouvelle value de la borne inférieure lowerBound
Définition à la ligne 143 du fichier MuteVar.h. Références lowerBound.

void Modelib::MuteVar::SetRelaxed | ( | bool | _isRelaxed = `true` | ) | `[inline]`

| Définition à la ligne 158 du fichier MuteVar.h. Références isRelaxed.

void Modelib::MuteVar::SetType | ( | MuteVar::VarType | type | ) | `[inline]`

  | Seter du type de la variable Paramètres:
  | Mute::Vartype | le type de la variable
Définition à la ligne 132 du fichier MuteVar.h. Références BOOL, INT, isBool, et isInt.

void Modelib::MuteVar::SetUpperBound | ( | float | _value | ) | `[inline]`

  | Geter de la borne inférieure Paramètres:
  | _value | la nouvelle value de la borne upérieure upperBound
Définition à la ligne 147 du fichier MuteVar.h. Références upperBound.

## Documentation des données membres

bool Modelib::MuteVar::isBool`[private]`

| La variable est-elle booléenne? Définition à la ligne 49 du fichier MuteVar.h. Référencé par GetType(), operator=(), et SetType().

bool Modelib::MuteVar::isInt`[private]`

| La variable est-elle entière? Définition à la ligne 50 du fichier MuteVar.h. Référencé par GetType(), operator=(), et SetType().

bool Modelib::MuteVar::isLBStrict`[private]`

| La borne inférieure est-elle stricte? Définition à la ligne 51 du fichier MuteVar.h. Référencé par IsLowerBoundStrict(), operator=(), et SetIsLBStrict().

bool Modelib::MuteVar::isRelaxed`[private]`

| La variable est elle relaxée en float? Définition à la ligne 53 du fichier MuteVar.h. Référencé par IsRelaxed(), operator=(), et SetRelaxed().

bool Modelib::MuteVar::isUBStrict`[private]`

| La borne supérieure est-elle stricte? Définition à la ligne 52 du fichier MuteVar.h. Référencé par IsUpperBoundStrict(), operator=(), et SetIsUBStrict().

float Modelib::MuteVar::lowerBound`[private]`

| Value de la borne inférieure. Définition à la ligne 55 du fichier MuteVar.h. Référencé par GetLowerBound(), operator=(), et SetLowerBound().

float Modelib::MuteVar::upperBound`[private]`

| Value de la borne inférieure. Définition à la ligne 56 du fichier MuteVar.h. Référencé par GetUpperBound(), operator=(), et SetUpperBound().

float Modelib::MuteVar::value`[private]`

| Value de la variable après résolution. Définition à la ligne 54 du fichier MuteVar.h. Référencé par GetValue(), et operator=().

La documentation de cette classe a été générée à partir du fichier suivant:

- MuteVar.h