libhydro.core.seuil (version 0.2f, 2014-12-17)
index
/home/seb/PHyC_source/libhydro3/libhydro/core/seuil.py

Module seuil.
 
Ce module contient les classes:
    # Seuilhydro
    # Valeurseuil

 
Modules
       
libhydro.core._composant
libhydro.core.sitehydro
libhydro.core.sitemeteo

 
Classes
       
builtins.object
Valeurseuil
_Seuil(builtins.object)
Seuilhydro

 
class Seuilhydro(_Seuil)
    Seuilhydro(code, sitehydro=None, typeseuil=None, duree=None, nature=None, libelle=None, mnemo=None, gravite=None, commentaire=None, publication=None, valeurforcee=None, dtmaj=None, valeurs=None, strict=True)
 
Classe Seuilhydro.
 
Proprietes:
    code (string) = code seuil
    sitehydro (sitehydro.Sitehydro) = site hydro du seuil
    typeseuil (entier parmi NOMENCLATURE[528]) = type du seuil
    duree (numerique) = duree du seuil en minutes
    nature (entier parmi NOMENCLATURE[529]) = nature du seuil
    libelle (string[255]) = libelle du seuil
    mnemo (string[50]) = mnemonique
    gravite (0 < entier < 100)
    commentaire (texte)
    publication (entier parmi NOMENCLATURE[529]) = type de publication
    valeurforcee (bool)
    dtmaj (datetime.datetime) = date de mise a jour
    valeurs (liste de Valeurseuil)
 
    La duree n'est pertinente que pour les seuils de type gradient.
    Le libelle et le mnemonique sont exclusifs.
 
 
Method resolution order:
Seuilhydro
_Seuil
builtins.object

Methods defined here:
__eq__(self, other, attrs=None, ignore=None, lazzy=False)
Equal elaborate function.
 
Arguments:
    self, other
    attrs (iterable of strings, default to self.__class__.__all__attrs__ or
        __self.__dict__.keys() = the attrs to compare
    ignore (iterable of strings, default None) = attrs to ignore in the
        comparison
    lazzy (bool, default False) = if True does not test an attribute
        whose counterpart is None
 
NB: functool.partial could be smarter than a private class variable to
fix the default attrs list, but it doesn't work with 'self'.
__hash__(self)
__init__(self, code, sitehydro=None, typeseuil=None, duree=None, nature=None, libelle=None, mnemo=None, gravite=None, commentaire=None, publication=None, valeurforcee=None, dtmaj=None, valeurs=None, strict=True)
Initialisation.
 
Arguments:
    code (string) = code seuil
    sitehydro (sitehydro.Sitehydro) = site hydro du seuil
    typeseuil (entier parmi NOMENCLATURE[528]) = type du seuil
    duree (numerique) = duree du seuil en minutes
    nature (entier parmi NOMENCLATURE[529]) = nature du seuil
    libelle (string[255]) = libelle du seuil
    mnemo (string[50]) = mnemonique
    gravite (0 < entier < 100)
    commentaire (texte)
    publication (entier parmi NOMENCLATURE[529]) = type de publication
    valeurforcee (bool, defaut False)
    dtmaj (numpy.datetime64 string, datetime.datetime...) =
        date de mise a jour
    valeurs (liste de Valeurseuil)
    strict (bool, defaut True) = strict or fuzzy mode
__ne__(self, other, attrs=[], ignore=[], lazzy=False)

Data descriptors defined here:
publication
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)
valeurforcee
Return valeurforcee.

Data and other attributes defined here:
__all__attrs__ = ('sitehydro', 'code', 'typeseuil', 'duree', 'nature', 'libelle', 'mnemo', 'gravite', 'commentaire', 'publication', 'valeurforcee', 'dtmaj', 'valeurs')

Methods inherited from _Seuil:
__str__(self)
Return string representation from __unicode__ method.
__unicode__(self)
Return unicode representation.

Data descriptors inherited from _Seuil:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
code
Return code.
dtmaj
Class Datefromeverything.
 
A descriptor to store a datetime.datetime property that can be initiated
in different manners using numpy.datetime64 facilities.
duree
Return duree.
gravite
Return gravite.
nature
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)
typeseuil
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)
valeurs
Return valeurs.

 
class Valeurseuil(builtins.object)
    Valeurseuil(valeur, seuil=None, entite=None, tolerance=None, dtactivation=None, dtdesactivation=None, strict=True)
 
Classe Valeurseuil.
 
Proprietes:
    valeur (numerique) = valeur du seuil
    seuil (Seuilhydro ou Seuilmeteo)
    entite (Sitehydro, Station, Capteur ou Grandeurmeteo)
    tolerance (numerique)
    dtactivation (datetime.datetime)
    dtdesactivation (datetime.datetime)
 
  Methods defined here:
__eq__(self, other, attrs=None, ignore=None, lazzy=False)
Equal elaborate function.
 
Arguments:
    self, other
    attrs (iterable of strings, default to self.__class__.__all__attrs__ or
        __self.__dict__.keys() = the attrs to compare
    ignore (iterable of strings, default None) = attrs to ignore in the
        comparison
    lazzy (bool, default False) = if True does not test an attribute
        whose counterpart is None
 
NB: functool.partial could be smarter than a private class variable to
fix the default attrs list, but it doesn't work with 'self'.
__hash__(self)
__init__(self, valeur, seuil=None, entite=None, tolerance=None, dtactivation=None, dtdesactivation=None, strict=True)
Initialisation.
 
Arguments:
    valeur (numerique) = valeur du seuil
    seuil (Seuilhydro ou Seuilmeteo)
    entite (Sitehydro, Station, Capteur ou Grandeurmeteo)
    tolerance (numerique)
    dtactivation (numpy.datetime64 string, datetime.datetime...)
    dtdesactivation (numpy.datetime64 string, datetime.datetime...)
    strict (bool)
 
La navigabilite des valeurs vers le seuil est assuree par le
constructeur.
__ne__(self, other, attrs=[], ignore=[], lazzy=False)
__str__(self)
Return string representation from __unicode__ method.
__unicode__(self)
Return unicode representation.

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
Class Datefromeverything.
 
A descriptor to store a datetime.datetime property that can be initiated
in different manners using numpy.datetime64 facilities.
entite
Return entite.

Data and other attributes defined here:
__all__attrs__ = ('valeur', 'seuil', 'entite', 'tolerance', 'dtactivation', 'dtdesactivation')

 
Author
        Philippe Gouin <philippe.gouin@developpement-durable.gouv.fr>