Modelib: LagrangianParam class Reference

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

# Référence de la classe LagrangianParam

Classe représentant des multiplicateurs de Lagrange rattachés à un modèle. Plus de détails...

`#include <LagrangianParam.h>`

Liste de tous les membres

## Membres publics
| LagrangianParam ()
| LagrangianParam (Model &_model, std::string constraintName)
| LagrangianParam (Model &,VarId)
| LagrangianParam (const LagrangianParam &_n)
LagrangianParam & | operator= (const LagrangianParam &_m)
VarId | GetId () const
Model * | GetModel () const
float | GetValue () const
void | SetValue (float)
LagrangianParam & | operator= (float _value)
LagrangianParam & | operator+= (float _value)
LagrangianParam & | operator-= (float _value)
## Attributs Protégés
VarId | id
| identifiant de variable
Model * | model
| modèle de définition

## Description détaillée

Classe représentant des multiplicateurs de Lagrange rattachés à un modèle.

## Documentation des contructeurs et destructeurs

LagrangianParam::LagrangianParam | ( |  | ) | `[inline]`

| Constructeur par défaut

LagrangianParam::LagrangianParam | ( | Model & | _model,
|  | std::string | constraintName
| ) |

  | ! Constructeur requierant un modele pour être utiliser. Facilite la lisibilité des déclarations et permet de s'assurer que le modele existe et est valide. Paramètres:
  _Model | modèle d'existence du multiplicateur de Lagrange
  _value | value du multiplicateur de Lagrange
  _nom | nom de la variable

LagrangianParam::LagrangianParam | ( | Model & | _model,
|  | VarId | _id
| ) |

  | ! Constructeur requierant un modele pour être utiliser. Facilite la lisibilité des déclarations et permet de s'assurer que le modele existe et est valide. Paramètres:
  _Model | modèle d'existence du multiplicateur de Lagrange
  _value | value du multiplicateur de Lagrange
  _nom | nom de la variable

LagrangianParam::LagrangianParam | ( | const LagrangianParam & | _n | ) | `[inline]`

| Constructeur de recopie

## Documentation des méthodes

VarId LagrangianParam::GetId | ( |  | ) | const`[inline]`

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

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

| Geter du modèle Renvoie: Un pointeur sur le Model où est définie la varaible.

float LagrangianParam::GetValue | ( |  | ) | const

| Ceter de la value du multiplicateur de Lagrange . Renvoie: La value du multiplicateur de Lagrange

LagrangianParam& LagrangianParam::operator+= | ( | float | _value | ) | `[inline]`

| Opérateur d'attribution +=

LagrangianParam& LagrangianParam::operator-= | ( | float | _value | ) | `[inline]`

| Opérateur d'attribution -=

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

| Opérateur d'attribution =

LagrangianParam& LagrangianParam::operator= | ( | const LagrangianParam & | _m | ) | `[inline]`

| Opérateur de recopie

void LagrangianParam::SetValue | ( | float | _value | ) |

  | Seter de la value du multiplicateur de Lagrange . Paramètres:
  La | value du multiplicateur de Lagrange

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

- LagrangianParam.h
- LagrangianParam.cpp