Ordinateur de bord pour voiture de collection 7.1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ClVariable Class Reference
ClVariable & linked objects / function / properties

contient : Nom, valeur, [capteur (class capteur)] More...

Inheritance diagram for ClVariable:
Horloge VarEntretien clvarNumSeg clvartime VarInclinometer Asserv ClVarThread clVarEngineTime

Public Member Functions

def __init__ (self, Name, FMasque=15, FNumber=None, CapteurIn=None, Value=0, NAquis=0, Unit="%s", CmpBin=None, SeuilMax=None, SeuilMin=None, CmpDelay=0, FuncCal=None, FuncCalParam=None, FuncAction=None, FuncEvent=None)
 The constructor. More...
 
def Action (self)
 Defini l'action lors de l'appui sur le bouton ou à l'appel lors de l'ouverture en fonction de self.Value. More...
 
def AdCapteur (self, Capteur)
 add a physical or virtual sensor More...
 
def Addition (self, ValToAdd)
 add passed value to current value More...
 
def BValue (self)
 return the binary value. More...
 
def CValue (self)
 idem (créé pour les asservissements, voir plus bas) More...
 
def Format (self)
 retourne le resultat de Read() formaté avec la chaine définie self.Unit More...
 
def Moyenne (self, VLue)
 calculation of average value More...
 
def Read (self)
 fonction de lecture de la variable More...
 
def ReadPref (self, pref)
 lit et écrit la préférence (format string <—> format type(Value)) More...
 
def ReturnBinForValue (self, val)
 
def RValue (self)
 retourne la valeur réelle (si la variable est une valeur réelle) More...
 
def set (self, newVal)
 Set new Value. More...
 
def stop (self)
 
def WritePref (self)
 utilisé par historic.PrefWrite() More...
 

Public Attributes

 Aquis
 
 BinCmpTimer
 
 CmpBin
 
 CmpDelay
 
 FMasque
 
 FNumber
 
 FuncAction
 
 FuncCal
 
 FuncEvent
 
 FuncParam
 
 MoyenneIter
 
 MoyenneSomme
 
 NAquis
 
 SeuilMax
 
 SeuilMin
 

Static Public Attributes

int BinCmpTimer = 0
 
 Capteur = None
 
list ListAff = []
 
 ListeActions = None
 
list ListVnt = []
 
int MoyenneIter = 0
 nombre d'itération pour un calcul complet (50) More...
 
int MoyenneSomme = 0
 somme destinée au calcule de la moyenne des acquisition, sur NAquis acquisitions. More...
 
 Name = None
 
 Unit = None
 
 Value = None
 

Detailed Description

contient : Nom, valeur, [capteur (class capteur)]

Parameters
Name(string), OBLIGATOIRE !!!
FMasque= 15, (160 ms) voir Frequence de ClVariable
FNumber= None, voir Frequence de ClVariable
CapteurIn= None, Name of the sensor read by this ClVariable
Value= 0, default value at start
NAquis= 0, if > 0 : number of acquisition for meaning
Unit= "%s", a string like "%s km" for display only
CmpBin= None, for binary Value ClVariable, compare to true for alarm can be None, True or False (an alarm can be on False value)
SeuilMax= None, max "normal" value if != 0
SeuilMin= None, min "normal" value if != 0
CmpDelay= 0, minimum time to rest at "True" for binary value
FuncCal= None, fonction de calcul de la valeur appelé lors du .Read()
FuncCalParam= None, parametre(s) necessaire(s) au calcul de la fonction
FuncAction= None, fonction d'action appelée manuellement avec mavar.Action() (par un bouton par exemple). Inutile sur un asservissement
FuncEvent= None fonction à appeler lors d'un changement d'état de Value (event) --> FuncCal, FuncAction et FuncEvent peuvent être soit des actions de ListeActions (chaine de caractere donc), soit des fonctions() passée directement en parametre
Date
  • 2016 : creation
  • 5.0 sept 2018 modification :
  • 5.1 28/11/2018 modification :
    • ajout des propriétés FMasque (Masque de la fréquence) et FNumber (compteur de la Frequence)
  • 6.0 21/03/2020 odification :
    • supression du mécanisme de compensation des segments (maintenant c'est dans le capteur segment)
  • 7.0 / 6.3 aout 2020 modification :
    • ajout __callFunc()
    • ajout Addition(Value)
    • ajout set(new value)
    • suppression CmpSeuil et Cmp
    • ajout CmpBin
    • ajout SeuilMax
    • ajout SeuilMin
  • 7.1
    • ajout BinaryValue et param CmpDelay to manage minimum time for binary ON state

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  Name,
  FMasque = 15,
  FNumber = None,
  CapteurIn = None,
  Value = 0,
  NAquis = 0,
  Unit = "%s",
  CmpBin = None,
  SeuilMax = None,
  SeuilMin = None,
  CmpDelay = 0,
  FuncCal = None,
  FuncCalParam = None,
  FuncAction = None,
  FuncEvent = None 
)

The constructor.

init de la classe, toutes les valeurs par défaut sont ici.

Date
  • 2016 création
  • 5.1 28/11/2018 15:38 modification

Reimplemented in ClVarThread, VarEntretien, and Asserv.

Member Function Documentation

◆ Action()

def Action (   self)

Defini l'action lors de l'appui sur le bouton ou à l'appel lors de l'ouverture en fonction de self.Value.

Reimplemented in VarEntretien, VarInclinometer, and Asserv.

◆ AdCapteur()

def AdCapteur (   self,
  Capteur 
)

add a physical or virtual sensor

Parameters
Capteur: the sensor to add

◆ Addition()

def Addition (   self,
  ValToAdd 
)

add passed value to current value

Date
6.2 23/08/2020 created
Parameters
ValToAddthe value to add to self.Value

Reimplemented in VentilateurPWM.

◆ BValue()

def BValue (   self)

return the binary value.

2021 (>7.1) The _BinaryValue is calculated in self.Read

Reimplemented in Asserv, VarEntretien, and VarInclinometer.

◆ CValue()

def CValue (   self)

idem (créé pour les asservissements, voir plus bas)

Reimplemented in Asserv, and VarInclinometer.

◆ Format()

def Format (   self)

retourne le resultat de Read() formaté avec la chaine définie self.Unit

Reimplemented in Horloge, VarEntretien, clvartime, clvarNumSeg, VarInclinometer, and Asserv.

◆ Moyenne()

def Moyenne (   self,
  VLue 
)

calculation of average value

Note
To use this, the ClVar must be init with the NAquis param pour les capteurs gérant un tableau d'acquisitions, retourne la moyenne des aquisitions principe :
  • on ajoute la dernière valeur,
  • on retranche la premiere valeur
  • on mémorise la somme
  • on divise la somme cette technique evite de faire une boucle for à chaque fois
Parameters
VLue: the new value to add in average
Returns
the average value for this ClVar

◆ Read()

def Read (   self)

fonction de lecture de la variable

  • si capteur : lit la valeur au capteur
  • réalise le calcule via la fonction de calcul
  • réalise la moyenne si NAquis > 0
  • calculate the BinayValue :
    • Value is int or real : False if the Value is between SeuilMin and SeuilMax ; True outside
    • Value is binary : BinayValue = self.Value
    • calulate the time to stay at True
  • appelle la fonction d'action si la valeur à changé (et fonction d'action existe)
  • renvoie la valeur finale.
    Date
    • 2016 : creation
    • 5.0 : sept 2018 : modification : Ajout de la possibilité de déclencher une methode lorsque la valeur self.Value change
    • 7.1 ajout self._BinaryValue

Reimplemented in VarEntretien, VarInclinometer, clVarEngineTime, ClVarThread, and Asserv.

◆ ReadPref()

def ReadPref (   self,
  pref 
)

lit et écrit la préférence (format string <—> format type(Value))

Parameters
prefthe value to load the current ClVar

Reimplemented in VarInclinometer.

◆ ReturnBinForValue()

def ReturnBinForValue (   self,
  val 
)

◆ RValue()

def RValue (   self)

retourne la valeur réelle (si la variable est une valeur réelle)

◆ set()

def set (   self,
  newVal 
)

Set new Value.

Date
6.2 23/08/2020 created
Parameters
newVal: the value to set in self.Value

◆ stop()

def stop (   self)

Reimplemented in PID_RgMot, PID_RgMot, Starter, ClVarThread, and Asserv.

◆ WritePref()

def WritePref (   self)

utilisé par historic.PrefWrite()

Reimplemented in VarInclinometer.

Member Data Documentation

◆ Aquis

Aquis

◆ BinCmpTimer [1/2]

int BinCmpTimer = 0
static

◆ BinCmpTimer [2/2]

BinCmpTimer

◆ Capteur

Capteur = None
static

◆ CmpBin

CmpBin

◆ CmpDelay

CmpDelay

◆ FMasque

FMasque

◆ FNumber

FNumber

◆ FuncAction

FuncAction

◆ FuncCal

FuncCal

◆ FuncEvent

FuncEvent

◆ FuncParam

FuncParam

◆ ListAff

list ListAff = []
static

◆ ListeActions

ListeActions = None
static

◆ ListVnt

list ListVnt = []
static

◆ MoyenneIter [1/2]

int MoyenneIter = 0
static

nombre d'itération pour un calcul complet (50)

◆ MoyenneIter [2/2]

MoyenneIter

◆ MoyenneSomme [1/2]

int MoyenneSomme = 0
static

somme destinée au calcule de la moyenne des acquisition, sur NAquis acquisitions.

◆ MoyenneSomme [2/2]

MoyenneSomme

◆ Name

Name = None
static

◆ NAquis

NAquis

◆ SeuilMax

SeuilMax

◆ SeuilMin

SeuilMin

◆ Unit

Unit = None
static

◆ Value

Value = None
static
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.3