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

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

#include <LagrangianParam.h>

Diagramme de collaboration de Modelib::LagrangianParam:

[Légende]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)
	~LagrangianParam ()
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.

Définition à la ligne 44 du fichier LagrangianParam.h.

---

Documentation des contructeurs et destructeurs

Modelib::LagrangianParam::LagrangianParam (   )  [inline]

Constructeur par défaut Définition à la ligne 60 du fichier LagrangianParam.h.

Modelib::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 Définition à la ligne 50 du fichier LagrangianParam.cpp. Références Modelib::Model::GetConstraint(), et Modelib::Constraint::GetId().

Voici le graphique d'appel pour cette fonction:

Modelib::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 Définition à la ligne 78 du fichier LagrangianParam.cpp. Références Modelib::Model::GetConstraint(), et Modelib::VarId.

Voici le graphique d'appel pour cette fonction:

Modelib::LagrangianParam::LagrangianParam (  const LagrangianParam &  _n  )  [inline]

Constructeur de recopie Définition à la ligne 67 du fichier LagrangianParam.h.

Modelib::LagrangianParam::~LagrangianParam (   )  [inline]

Définition à la ligne 112 du fichier LagrangianParam.h.

---

Documentation des méthodes

VarId Modelib::LagrangianParam::GetId (   )  const [inline]

Geter de l'identifiant de variable Renvoie: L'identifiant de variable sous le format VarId. Définition à la ligne 80 du fichier LagrangianParam.h. Références Modelib::VarId.

Model* Modelib::LagrangianParam::GetModel (   )  const [inline]

Geter du modèle Renvoie: Un pointeur sur le Model où est définie la varaible. Définition à la ligne 85 du fichier LagrangianParam.h. Référencé par Modelib::Expr::Simplify().

float Modelib::LagrangianParam::GetValue (   )  const

Ceter de la value du multiplicateur de Lagrange . Renvoie: La value du multiplicateur de Lagrange Définition à la ligne 102 du fichier LagrangianParam.cpp. Références Modelib::Model::GetLagrangianParamValue(). Référencé par operator+=(), operator-=(), et Modelib::Expr::Simplify().

Voici le graphique d'appel pour cette fonction:

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

Opérateur d'attribution += Définition à la ligne 98 du fichier LagrangianParam.h. Références GetValue(), et SetValue().

Voici le graphique d'appel pour cette fonction:

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

Opérateur d'attribution -= Définition à la ligne 105 du fichier LagrangianParam.h. Références GetValue(), et SetValue().

Voici le graphique d'appel pour cette fonction:

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

Opérateur d'attribution = Définition à la ligne 91 du fichier LagrangianParam.h. Références SetValue().

Voici le graphique d'appel pour cette fonction:

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

Opérateur de recopie Définition à la ligne 70 du fichier LagrangianParam.h. Références id, et model.

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

Seter de la value du multiplicateur de Lagrange . Paramètres: La  value du multiplicateur de Lagrange Définition à la ligne 122 du fichier LagrangianParam.cpp. Références Modelib::Model::SetLagrangianParamValue(). Référencé par operator+=(), operator-=(), et operator=().

Voici le graphique d'appel pour cette fonction:

---

Documentation des données imbriquées

VarId Modelib::LagrangianParam::id [protected]

identifiant de variable Définition à la ligne 47 du fichier LagrangianParam.h. Référencé par operator=().

Model* Modelib::LagrangianParam::model [protected]

modèle de définition Définition à la ligne 48 du fichier LagrangianParam.h. Référencé par operator=().

---

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

• /LagrangianParam.h
• /LagrangianParam.cpp

---