zd_coord_obj_stream.hpp

/* zd_coord_obj_stream.hpp */
/* $Id: zd_coord_obj_stream.hpp,v 1.2 2007/04/13 19:57:50 vlad Exp $ */
#ifndef __zd_coord_obj_stream_hpp
#define __zd_coord_obj_stream_hpp

#include "zqb_types.h"
#include "zd_document.hpp"


class ZdCoordObjStream : public ZdDocument
{
public:
  
  union CoordArgVal
  {
    int i;   
    float f; 
    char c;  
  };

  struct CoordSelection
  {
    CoordSelection():
      coordId(0), argType(Z_T_INT32) {/* nothing to do */}
    
    int coordId;                   
    ZqbType argType;               
    std::vector<CoordArgVal> args; 
  };
  
  typedef std::vector<CoordSelection> CoordSelectionVec;
  
  ZdCoordObjStream (const char* szDocName = NULL);


  virtual void setCustomCoord(int iCoordId);
  
  virtual int getCustomCoord() const {return 0;}
  
  
  virtual void      setFirstOrder (int iCoordId,
                       ZqbOrder eOrder = Z_O_ASCENT);
  
  virtual bool          getFirstOrder (int &iCoordId, ZqbOrder &eOrder) const; 


  virtual void      setSecondaryOrder (int iSecondaryId,
                       ZqbOrder eOrder = Z_O_ASCENT);

  virtual bool          getSecondaryOrder (int &iCoordId, ZqbOrder &eOrder) const;

  virtual void      setTertiaryOrder (int iTertiaryId,
                      ZqbOrder eOrder = Z_O_ASCENT);
  
  virtual bool          getTertiaryOrder (int &iCoordId, ZqbOrder &eOrder) const;
  

  virtual void setCoordsSelection(const CoordSelectionVec &selCoords);
    
  virtual const CoordSelectionVec& getCoordsSelection() const;
  

  virtual void setInvisibleCoordinates(const CoordSelectionVec &unvisibleCoords);
  
  virtual const CoordSelectionVec& getInvisibleCoordinates() const;


  virtual bool      getCoordRange (double c[2]) = 0;
  
  virtual double    averageCoordStep () = 0;

  virtual int       maxEnsembleLength () = 0;


  /*
   * Iterator methods.
   */

  virtual bool      goFirstCoord () = 0;

  virtual bool      goNextCoord () = 0;

  virtual double    coord () = 0;
  
  virtual bool visibleCoord () { return true; }
  
  virtual int       ensembleLength () = 0;

  virtual void*     custom (int ens_index = 0,
                ZqbType* pRetType = NULL);
  

  virtual ZqbType coordTypeFromId(int coordId) const;
  
private:

  CoordSelectionVec m_dummy_cs_vec;

  static int        s_iNameCounter;

  static const char     *s_szOwnType;

};


#endif /* zd_coord_obj_stream.hpp */