Selector.h

/* Selector.h */
/* $Id: Selector.h,v 1.13 2009/05/12 13:14:37 vlad Exp $ */
#ifndef __Selector_h
#define __Selector_h

#include <malloc.h>
#include <stdlib.h>

#include <mix/Types.h>
#include <ldb/trset.h>


/***********************************************************************
 * Types for selector state description.
 ***********************************************************************/
enum SelectorSortBy {
  sUnknownOrUndefined = -1,
  sRawOrder = 0,
  sCableDepthOrder,
  sMagnitogramOrder,
  sMagnitogramInverseOrder,
  sChannelOrder,
  sChannelInverseOrder,
  sSPNumberOrder,
  sRPNumberOrder,
  sDPNumberOrder,
  sCableDepthAzDipOrder,
  sCableDepthDipAzOrder,
  sAzimuthDipOrder,
  sDipAzimuthOrder,
  sSPOffsetOrder,
  sOffsetSPOrder,
  sRPOffsetOrder,

  sNslNssNrlNrs,
  sNrlNrsNslNss
};

/* Max number of remembered NTR */
#define MAX_nNTR    10

/* Pair of trace type+component */
typedef struct
{
  Logic enable;     /* toggle on/off flag */
  char  TYPE;       /* type of the trace */
  char  COMP;       /* component of the trace */
  int   nNTR;       /* real number of NTRs in trace set */
  int   NTRs[MAX_nNTR]; /* list of trace numbers but not more than MAX_nNTR */

}   TypeCompPair;


/* max string length for szNTRs and szNMGLs */
#define SS_NUMLIST_LEN      1024

/* visible part of szNTRs and szNMGLs strings */
#define SS_NUMLIST_WIDTH    15

/***********************************************************************
 * Selector structure is combined from component and trace number lists.
 ***********************************************************************/
struct SelectorSet
{
  enum SelectorSortBy   eSortBy;
  int           nPairs; /* COMP+TYPE selection */
  TypeCompPair      *pPairs;
  int           nNTRs;  /* NTR selection */
  int           *pNTRs;
  char  szNTRs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nNMGLs; /* NMGL selection */
  int           *pNMGLs;
  char  szNMGLs[SS_NUMLIST_LEN+1];  /* string representation */
  int           nNSPs;  /* NSP selection */
  int           *pNSPs;
  char  szNRPs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nNRPs;  /* NRP selection */
  int           *pNRPs;
  char  szNSPs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nNDPs;  /* NDP selection */
  int           *pNDPs;
  char  szNDPs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nVERs;  /* VER selection */
  int           *pVERs;
  
  char  szNSSs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nNSSs;  /* NSS selection */
  int           *pNSSs;
  char  szNSLs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nNSLs;  /* NSL selection */
  int           *pNSLs;
  char  szNRSs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nNRSs;  /* NRS selection */
  int           *pNRSs;
  char  szNRLs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nNRLs;  /* NRL selection */
  int           *pNRLs;
  
  char  szVERs[SS_NUMLIST_LEN+1];   /* string representation */
  int           nLrange[2]; /* L range selection */

  char  *szExpr;    
};


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* Paste all type+comp pairs from input modification. */
ErrCode PasteTypeCompPairs (TrSet* its, int* n_pairs, TypeCompPair** pairs);

/* Compose string with TYPE,COMP pair and NTR list. */
char*   ComposeTypeCompLabel (char* szLabelBuf, TypeCompPair* pair);

/* Copy selector to uninitialized variable */
void    CopySelector (struct SelectorSet* dst,
              const struct SelectorSet* src);

/* Release memory under the selector and assign zeros to it's contents */
void    FreeSelector (struct SelectorSet* dst);

ErrCode SaveSelector ();

ErrCode LoadSelector ();

const char* SelectorSortByToString (enum SelectorSortBy eSortBy);

enum SelectorSortBy SelectorSortByFromString (const char* szSortBy);

#ifdef __cplusplus
};
#endif /* __cplusplus */



#ifdef __cplusplus

/* Build index table. */
ErrCode SelectTraces (SelectorSet& ss, TrSet* ts, TrIndexTable* it);

/* Class SelectorSet object initialization and save/load operations */
class SelectorSetObject
{
private:
  SelectorSet   *selset;

public:
  SelectorSetObject (SelectorSet* ss)
    : selset(ss)
    {
      if(NULL == selset)
    return;

      selset->eSortBy = sRawOrder;
      selset->nPairs = 0;
      selset->pPairs = NULL;
      selset->nNTRs = 0;
      selset->pNTRs = NULL;
      selset->nNMGLs = 0;
      selset->pNMGLs = NULL;
      selset->nNSPs = 0;
      selset->pNSPs = NULL;
      selset->nNRPs = 0;
      selset->pNRPs = NULL;
      selset->nNDPs = 0;
      selset->pNDPs = NULL;
      selset->nNSLs = 0;
      selset->pNSLs = NULL;
      selset->nNSSs = 0;
      selset->pNSSs = NULL;
      selset->nNRLs = 0;
      selset->pNRLs = NULL;
      selset->nNRSs = 0;
      selset->pNRSs = NULL;
      selset->nVERs = 0;
      selset->pVERs = NULL;
      selset->szNTRs[0] = '\0';
      selset->szNMGLs[0] = '\0';
      selset->szNSPs[0] = '\0';
      selset->szNDPs[0] = '\0';
      selset->szNRPs[0] = '\0';
      selset->szNSLs[0] = '\0';
      selset->szNSSs[0] = '\0';
      selset->szNRLs[0] = '\0';
      selset->szNRSs[0] = '\0';
      selset->szVERs[0] = '\0';
      selset->nLrange[0] = 0;
      selset->nLrange[1] = 0;
      selset->szExpr = NULL;
    };
  virtual ~SelectorSetObject ()
    {
      if(NULL == selset)
    return;
      FreeSelector(selset);
    };

  ErrCode   save (const char* szFilePath);
  ErrCode   load (const char* szFilePath);
};
#endif /* __cplusplus */


#ifndef __SelectorVars

/* Actual state of state selector */
extern struct SelectorSet   rSelSet;


extern char *SelectorSet_szSortBy[];
extern int  SelectorSet_nSortBy;


#endif /* __SelectorVars */

#endif /* Selector.h */