libhydro.core.courbetarage (version 0.1, 2017-06-13)
index
/home/seb/PHyC_source/libhydro3/libhydro/core/courbetarage.py

Module courbetarage
 
Ce module contient les classes:
    # CourbeTarage
    # PivotCT
    # PivotCTPuissance
    # PivotCTPOly
    # PeriodeCT
    # HistoActivePeriode

 
Modules
       
libhydro.core._composant
datetime
libhydro.core.intervenant
libhydro.core.sitehydro

 
Classes
       
builtins.object
CourbeTarage
HistoActivePeriode
PeriodeCT
PivotCT
PivotCTPoly
PivotCTPuissance

 
class CourbeTarage(builtins.object)
    CourbeTarage(code=None, libelle=None, station=None, typect=0, limiteinf=None, limitesup=None, dn=None, alpha=None, beta=None, commentaire=None, contact=None, pivots=None, periodes=None, dtmaj=None, dtcreation=None, limiteinfpub=None, limitesuppub=None, commentaireprive=None, tri_pivots=True, strict=True)
 
Classe CourbeTarage.
 
Classe pour manipuler des courbes de tarage.
 
Proprietes:
    code (string) = code courbe tarage
    typect (int parmi NOMENCLATURE[503]) 0 ou 4
    libelle (string)
    limiteinf (float) = limite inférieure d'utilisation
    limitesup (float) = limite supérieure d'utilisation
    dn (float or None) = dénivelé (station à pente)
    alpha (float or None) (station à pente)
    beta (float or None) (station à pente)
    commentaire (string or Noe)
    station (sitehydro.Station)
    contact (intervenant.Contact or None)
    pivots (iterable of PivotCTPoly (typect = 0))
    periodes (PeriodeCT or an iterable of PeriodeCT)
        or PivotCTPoly (typect = 4)
    dtmaj (datetime.datetime) = date de mise à jour
    dtcreation (datetime.datetime or None) = date de création
    limiteinfpub (float or None) = Limite inférieure de publication
    limitesuppub (float or None) = Limite supérieure de publication
    commentaireprive (str or None) = commentaire privé
    tri_pivots (bool) = tri de spoints pivots par hauteur si True
 
  Methods defined here:
__init__(self, code=None, libelle=None, station=None, typect=0, limiteinf=None, limitesup=None, dn=None, alpha=None, beta=None, commentaire=None, contact=None, pivots=None, periodes=None, dtmaj=None, dtcreation=None, limiteinfpub=None, limitesuppub=None, commentaireprive=None, tri_pivots=True, strict=True)
tri_pivots (bool) tri des points en fonction de la hauteur
__str__(self)
Return string representation from __unicode__ method.
__unicode__(self)
Return unicode representation.
get_used_actived_periodes(self)
Return periodes used (periode.etat=8) and not deactived
is_active(self, dte)
check if the CourbeTarge is used and actived at dte

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
alpha
Return alpha.
beta
Return coefficient beta.
code
Return code courbe tarage.
contact
Return contact.
dn
Return denivelle.
dtcreation
Class Datefromeverything.
 
A descriptor to store a datetime.datetime property that can be initiated
in different manners using numpy.datetime64 facilities.
dtmaj
Return contact.
libelle
Return libelle courbe tarage.
limiteinf
Return limiteinf.
limiteinfpub
Return limiteinfpub.
limitesup
Return limitesup.
limitesuppub
Return limitesuppub.
periodes
Return periodes.
pivots
Return capteurs.
station
Return code courbe tarage.
typect
Class Nomenclatureitem.
 
A descriptor to deal with 'in nomenclature.NOMENCLATURES' properties.
 
Should raise only a ValueError when value is not allowed (even with
the None case).
 
Properties:
    nomenclature (int) = the nomenclature ref
    valuetype (type) = a function to cast values to the nomenclature's
        items type
    strict (bool, default True) = wether or not the instance value has
        to be in the nomenclature items
    required (bool, defaut True) = wether or not instance's value can
        be None
    default =  a defautl value returned if the instance's value is not
        in the dictionnary. Should be unused if the property has been
        initialized.
    data (weakref.WeakKeyDictionary)

 
class HistoActivePeriode(builtins.object)
    HistoActivePeriode(dtactivation=None, dtdesactivation=None)
 
Classe HistoActivePeriode
 
Classe pour manipuler l'historique d'activation des periodes
d'une courbe de tarage.
Vérification que la date de désactivation si elle est définie
est ultérieure à la date d'activation
 
Proprietes:
    dtactivation (datetime.datetime)
    dtdesactivation (datetime.datetime ou None)
 
  Methods defined here:
__init__(self, dtactivation=None, dtdesactivation=None)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
dtactivation
Class Datefromeverything.
 
A descriptor to store a datetime.datetime property that can be initiated
in different manners using numpy.datetime64 facilities.
dtdesactivation
Return dtdesactivation

 
class PeriodeCT(builtins.object)
    PeriodeCT(dtdeb=None, dtfin=None, etat=8, histos=None, strict=True)
 
Classe Periode CT.
 
Classe pour manipuler des périodes d'activation d'une courbe de tarage.
 
Proprietes:
    dtdeb (datetime.datetime)
    dtfin (datetime.datetime)
    etat (int in NOMENCLATURE[504])
        0: 'Non utilisable', 4:'Utilisable', 8: 'Utilisée', 12: 'Travail'
    histos (iterable of HistoActivePeriode ou None)
 
  Methods defined here:
__init__(self, dtdeb=None, dtfin=None, etat=8, histos=None, strict=True)
Initialize self.  See help(type(self)) for accurate signature.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
dtdeb
Class Datefromeverything.
 
A descriptor to store a datetime.datetime property that can be initiated
in different manners using numpy.datetime64 facilities.
dtfin
Class Datefromeverything.
 
A descriptor to store a datetime.datetime property that can be initiated
in different manners using numpy.datetime64 facilities.
etat
Class Nomenclatureitem.
 
A descriptor to deal with 'in nomenclature.NOMENCLATURES' properties.
 
Should raise only a ValueError when value is not allowed (even with
the None case).
 
Properties:
    nomenclature (int) = the nomenclature ref
    valuetype (type) = a function to cast values to the nomenclature's
        items type
    strict (bool, default True) = wether or not the instance value has
        to be in the nomenclature items
    required (bool, defaut True) = wether or not instance's value can
        be None
    default =  a defautl value returned if the instance's value is not
        in the dictionnary. Should be unused if the property has been
        initialized.
    data (weakref.WeakKeyDictionary)
histos
Return histos.

 
class PivotCT(builtins.object)
    PivotCT(hauteur=None, qualif=16, strict=True)
 
Classe CourbeTarage.
 
Classe abstraite commune aux deux classes PivotCTPoly et PivotCTPuissance
 
Proprietes:
    hauteur (float)
    qualif (int in NOMENCLATURE[505]) = qualification du point pivot
 
  Methods defined here:
__gt__(self, other)
Return self>value.
__init__(self, hauteur=None, qualif=16, strict=True)
Initialisation
 
Arguments:
   hauteur (float)
   qualif (int in NOMENCLATURE[505])
__lt__(self, other)
Return self<value.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
hauteur
Return hauteur.
qualif
Class Nomenclatureitem.
 
A descriptor to deal with 'in nomenclature.NOMENCLATURES' properties.
 
Should raise only a ValueError when value is not allowed (even with
the None case).
 
Properties:
    nomenclature (int) = the nomenclature ref
    valuetype (type) = a function to cast values to the nomenclature's
        items type
    strict (bool, default True) = wether or not the instance value has
        to be in the nomenclature items
    required (bool, defaut True) = wether or not instance's value can
        be None
    default =  a defautl value returned if the instance's value is not
        in the dictionnary. Should be unused if the property has been
        initialized.
    data (weakref.WeakKeyDictionary)

 
class PivotCTPoly(PivotCT)
    PivotCTPoly(hauteur=None, qualif=16, debit=None, strict=True)
 
Classe PivotPolyCT
 
Classe pour manipuler des points pivots d'une courbe de tarage puissance.
 
Proprietes:
    hauteur (float)
    qualif (int in NOMENCLATURE 505)
    debit (float)
 
 
Method resolution order:
PivotCTPoly
PivotCT
builtins.object

Methods defined here:
__init__(self, hauteur=None, qualif=16, debit=None, strict=True)
Initialisation
 
Arguments:
   hauteur (float)
   qualif (int in NOMENCLATURE[505])
__str__(self)
Return string representation from __unicode__ method.
__unicode__(self)
Return unicode representation.

Data descriptors defined here:
debit
Return debit.

Methods inherited from PivotCT:
__gt__(self, other)
Return self>value.
__lt__(self, other)
Return self<value.

Data descriptors inherited from PivotCT:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
hauteur
Return hauteur.
qualif
Class Nomenclatureitem.
 
A descriptor to deal with 'in nomenclature.NOMENCLATURES' properties.
 
Should raise only a ValueError when value is not allowed (even with
the None case).
 
Properties:
    nomenclature (int) = the nomenclature ref
    valuetype (type) = a function to cast values to the nomenclature's
        items type
    strict (bool, default True) = wether or not the instance value has
        to be in the nomenclature items
    required (bool, defaut True) = wether or not instance's value can
        be None
    default =  a defautl value returned if the instance's value is not
        in the dictionnary. Should be unused if the property has been
        initialized.
    data (weakref.WeakKeyDictionary)

 
class PivotCTPuissance(PivotCT)
    PivotCTPuissance(hauteur=None, qualif=16, vara=None, varb=None, varh=None, strict=True)
 
Classe PivotPolyCT
 
Classe pour manipuler des points pivots d'une courbe de tarage puissance.
 
Proprietes:
    hauteur (float)
    qualif (int in NOMENCLATURE[505])
    vara (float)
    varb (float)
    varh (float)
    libelle (string)
 
 
Method resolution order:
PivotCTPuissance
PivotCT
builtins.object

Methods defined here:
__init__(self, hauteur=None, qualif=16, vara=None, varb=None, varh=None, strict=True)
Initialisation
 
Arguments:
   hauteur (float)
   qualif (int in NOMENCLATURE[505])
__str__(self)
Return string representation from __unicode__ method.
__unicode__(self)
Return unicode representation.

Data descriptors defined here:
vara
Return vara.
varb
Return varb.
varh
Return varh.

Methods inherited from PivotCT:
__gt__(self, other)
Return self>value.
__lt__(self, other)
Return self<value.

Data descriptors inherited from PivotCT:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
hauteur
Return hauteur.
qualif
Class Nomenclatureitem.
 
A descriptor to deal with 'in nomenclature.NOMENCLATURES' properties.
 
Should raise only a ValueError when value is not allowed (even with
the None case).
 
Properties:
    nomenclature (int) = the nomenclature ref
    valuetype (type) = a function to cast values to the nomenclature's
        items type
    strict (bool, default True) = wether or not the instance value has
        to be in the nomenclature items
    required (bool, defaut True) = wether or not instance's value can
        be None
    default =  a defautl value returned if the instance's value is not
        in the dictionnary. Should be unused if the property has been
        initialized.
    data (weakref.WeakKeyDictionary)

 
Author
        Sebastien ROMON