PoTimeAxis.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef  _PO_TIME_AXIS_
#define  _PO_TIME_AXIS_
 
#include <MeshViz/graph/PoAxis.h>
#include <MeshViz/graph/PbDateFormatMapping.h>
#include <MeshViz/graph/PiNumericFormat.h>
#include <MeshViz/graph/PiDate.h>
 
 
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoMFString.h>
 
 
class SoMatrixTransform ;

class  PoTimeAxis : public PoAxis {
 
  SO_KIT_HEADER(PoTimeAxis) ;
 
 
 public:

  enum Language {
    ENGLISH,   
    FRANCAIS,  
    DEUTSCH,   
    ESPANOL    
  } ;
 
  enum GradFit {
    GRAD_FIT,  
    GRAD_UNFIT 
  } ;
 
 

  enum Type {
    X,         
    Y          
  } ;
 
  /* Fields */

  SoSFString startDate ;

  SoSFString endDate ;

  SoSFFloat  coord ;

  SoSFEnum   type ;

  SoSFEnum   language ;

  SoSFEnum   gradFit ;

  SoMFString gradRep ;

  SoSFString timesPeriod ;
 
  /* Methods */

  PoTimeAxis()
    { init(TRUE) ; }

  PoTimeAxis(const char *_startDate, const char *_endDate, float _coord,
             Type _type = X)
    { init(FALSE, _startDate, _endDate, _coord, _type) ; }

  virtual void rebuild() ;

  void setDateFormatMapping(PbDateFormatMapping *formatMapping) ;

  const PbDateFormatMapping *getDateFormatMapping() const ;
 
  /*----------------------------------------------------------------------------*/
 
 private:
 
  static void initClass() ;
    static void exitClass() ;
 
  enum Tdate_elem_form {
    TSECOND,
    TMINUTE,
    THOUR,
    TDAY_NUMBER, 
    TWEEK_DAY,
    TMONTH_NUMBER,
    TYEAR_MONTH,
    TYEAR
  } ;
 
  enum Tdate_step {
    TSTEP_UNKNOWN,
    TSTEP_SECONDS,
    TSTEP_MINUTES,
    TSTEP_HOURS,
    TSTEP_DAYS,
    TSTEP_MONTHS,
    TSTEP_YEARS
  } ;
 
  struct Tdate_elem {
    int                form_prefixe;  // prefixe du code
    Tdate_elem_form    form;          // code calendaire
    char               *append_str;   // string commentaire apres le code
  } ;
 
 
  struct Tdate_axis_level_rep {
    Tdate_step       step;            // unite de pas calendaire du niveau
    float            num_step;        // nombre d'unite de pas
    int              ten_power;       // puis de 10 pour pas seconde
    char             *append_str;     // string commentaire prefixe
    int              num_date_elems;  // nb de code cal par graduation
    Tdate_elem       *date_elems;     // liste des code calendaire
  } ;
 
  struct Tdate_axis_rep {
    int                   num_level;   // nb de niveaux de l'axe
    Tdate_axis_level_rep  *level_rep;  // liste des rep. par niveau
  } ;
 
  struct Tdate_interv {
    float        num_units;
    Tdate_step   units;
  } ;
 
  struct Tdate_list {                        
    int           num_dates;       // nb d'intervalles de date - 1 
    Tdate_interv  *dates;          // liste des dates
  }  ;
 
 private:
  // Time axis attr
  struct TimeAxisAttr {
    PbDateFormatMapping *formatMapping ;
    PiDate              startDate ;
    PiDate              endDate ;
    PiNumericFormat     numericFormat ;
    Plane               plane ;
    int                 num_date_limit ;
    PiDate              *date_limit ;
    int                 num_rep ;
    Tdate_axis_rep      *date_axis_rep ;
  } ;
 
  // Methods
  // Destructor
  virtual ~PoTimeAxis() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
  virtual void   setDefaultOnNonWritingFields() ;
 
  // Manage the connection with PbBase objects
  virtual void basicObjectChange(PbBase *basicObj) ;
 
  // Save all axis attributes which can be modified by MeshViz.
  virtual void saveAxisAttr() ;
 
  // Overloaded methods
  virtual void preRebuild() ;
  virtual void addElementsAllCaches() ;
 
 private:
  // Init method
  void init(SbBool isDefault, const char *startDate=NULL, const char *endDate=NULL, 
            float coord=0.0, Type type = X) ;
 
  // Compute axis tranformation
  void computeTransfo(const SbVec2f &refPoint, SoMatrixTransform *transfo, 
                      float &deltaX, float &deltaY) ;
 
  // Get the date axis representation
  void getDateAxisRep(const PiDate &date_min, const PiDate &date_max,
                      Tdate_axis_rep &date_rep) ;
 
  // Copy a date representatiom
  static void copyDateRep(Tdate_axis_rep &dst_date_rep, 
                          const Tdate_axis_rep &src_date_rep) ;
 
  // Init date step of level 0
  static void initDateStepOfLevel0(Tdate_axis_rep &date_rep, const PiDate &date_delta) ;
 
  // Init date element
  static void initDateElem(Tdate_axis_level_rep &level_rep) ;
 
  // Init step, the unit step is given
  static void initDateNumStep(Tdate_axis_level_rep &level_rep, const PiDate &date_delta) ;
 
  // Free a date axis rep (all fields are free)
  static void freeDateAxisRep(Tdate_axis_rep &axis_rep) ;
 
  // Free a list of Tdate_axis_rep
  static void freeDateAxisRepList(int num_axis_rep, Tdate_axis_rep *axis_rep_list) ;
 
  // Compute automactic date representation
  void initAutoRep(const PiDate &date_delta, Tdate_axis_rep &date_rep) ;
 
  // Choose best date representation from a list of date representation
  void chooseBestDateRep(int num_rep, const Tdate_axis_rep *rep, 
                         const PiDate &date_delta, Tdate_axis_rep &date_rep) ;
 
  // Get list of graduations
  void getGradList(const PiDate &date_1, const PiDate &date_2, 
                   GradFit grad_fit,
                   const Tdate_axis_level_rep &level_rep,
                   int &num_gradu, char ***gradu_string_list,
                   std::vector<float>& x_gradu_list) ;
 
  // Get first date graduation
  void getFirstDateGrad(const PiDate &date_1, const PiDate &date_2, 
                        Tdate_step step, float float_step, GradFit
                        grad_fit, PiDate &date_ref) ;
 
  // Get string associated to a internal date
  void getStringDate(const PiDate &date, int form_prefixe, 
                     Tdate_elem_form form, char *string_date) ;
 
  // Build date graduations
  void buildDateGrads(const PiDate &date_1, const PiDate &date_2, 
                      const Tdate_axis_rep &date_rep, SoGroup *group) ;
 
  // Set date axis representation from the two associated fields
  // gradRep and timesPeriod.
  void setDateAxisRep() ;
 
  //--------- All this methods are used for the parser of timesPeriod --------
  static void parseDateList(char *form, Tdate_list *dl, int *err_ind) ;
  static void parseDateListNewDate(double num_units, int units) ;
  static Tdate_list *date_list ;
  friend int tpdlparse(void);
  friend int tpdllex(void) ;
 
  //--------- All this methods are used for the parser of gradRep ------------
  static void parseAxisRep(char *form, int n_l, Tdate_axis_rep *da_rep, 
                           int *err_ind) ;
  static void parseAxisRepNewLevel(double num_step, int step, char *append_str) ;
  static void parseAxisRepAddToLevel(int form_prefixe, int form, char *append_str) ;
  static Tdate_axis_rep *date_axis_rep ;
  friend int tpaxparse(void) ;
  friend int tpaxlex(void) ;
 
  // Computed axis attributes
  TimeAxisAttr timeAxisAttr ;
 
  // Date format and mapping
  PbDateFormatMapping *m_dateFormatMapping, m_defaultDateFormatMapping ;
 
  // Sensors
  FieldSensorList fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     fieldList ;
 
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_TIME_AXIS_ */