ngcbPARAM.hpp

Go to the documentation of this file.

#ifndef ngcbPARAM_H
#define ngcbPARAM_H
 
 
#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif
 
#include <ngc/core/ngcb.h>
#include <ngc/core/ngcbBITLIST.hpp>
 
/*
 * Parameter type definitions
 */
#define ngcbPARAM_CHAR       0  //< Logical ('T' or 'F' or 0 or 1)
#define ngcbPARAM_INT        1  //< 32-bit signed integer
#define ngcbPARAM_FLOAT      2  //< 32-bit floating point
#define ngcbPARAM_DOUBLE     3  //< 64-bit floating point
#define ngcbPARAM_STRING     4  //< String
 
/*
 * Some flags for ctrl-list
 */
#define ngcbPARAM_FLAG_FREE 31  //< Free parameter
#define ngcbPARAM_FLAG_CFG  30  //< Front-end configuration parameter
#define ngcbPARAM_FLAG_MODE 29  //< Read-mode specific parameter

#define ngcbPARAM_MAX_STRING  255

class ngcbPARAM {
public:
  unsigned int ctrlList;

  unsigned int acqList;            

  char name[64]; 

  char alias[64];

  char format[16]; 

  int fits;

  char comment[44];

  char unit[8];  

  int attribute;               

  bool operator ==(const ngcbPARAM& other) const;
 
  bool operator !=(const ngcbPARAM& other) const;
 
  ngcbPARAM &operator=(const ngcbPARAM &other);

  ngcbPARAM(const ngcbPARAM &other);

  ngcbPARAM();

  explicit ngcbPARAM(const char *paramName); 

  ngcbPARAM(const char *paramName, char initVal); 

  ngcbPARAM(const char *paramName, int initVal); 

  ngcbPARAM(const char *paramName, float initVal); 

  ngcbPARAM(const char *paramName, double initVal);

  ngcbPARAM(const char *paramName, const char *initVal); 

  ngcbPARAM(const char *paramName, const char *initVal, int type); 

  virtual ~ngcbPARAM();     

  int Comp(ngcbPARAM &p);
  
  int Changed();

  void Alias(const char *a);

  int Type();   

  void Type(int newType);

  int Set(char newValue);     

  int Set(int newValue);           

  int Set(float newValue); 

  int Set(double newValue); 

  int Set(const char *newValue); 

  char ValChar() const;

  int ValInt() const; 

  float ValFloat() const; 

  double ValDouble() const;  

  const char *ValString(); 

  const char *Get();            

  void Get(char *stringVal) const;

  void Store(); 

  void Restore();         
 
protected:
 
private:
  void Init_();

  void *value_; 

  void *tmpValue_;

  int type_;

  int size_;  

  int changed_; 

  char stringVal_[ngcbPARAM_MAX_STRING + 1];

  char tmpString_[ngcbPARAM_MAX_STRING + 1]; 

  int Comp_(const ngcbPARAM &p) const; 
};
 

class ngcbPARAM_LIST {
public:
  ngcbPARAM *param;

  ngcbPARAM_LIST *next;

  ngcbPARAM_LIST();

  ngcbPARAM_LIST(ngcbPARAM *newParam, int noDelete);

  virtual ~ngcbPARAM_LIST();     

  ngcbPARAM_LIST *First();

  ngcbPARAM *Add(ngcbPARAM *newParam, int noDelete = 1); 

  ngcbPARAM *Add(const char *paramName);

  ngcbPARAM *Add(const char *paramName, char initVal);

  ngcbPARAM *Add(const char *paramName, int initVal); 

  ngcbPARAM *Add(const char *paramName, float initVal); 

  ngcbPARAM *Add(const char *paramName, double initVal);  

  ngcbPARAM *Add(const char *paramName, const char *initVal); 

  ngcbPARAM *Add(const char *paramName, const char *initVal, int type);

  void Remove(ngcbPARAM *item);

  void Remove(const char *paramName);

  void Clear(); 

  void Insert(ngcbPARAM_LIST &other);

  ngcbPARAM *Get(const char *paramName);

  int Set(const char *paramName, char paramValue);

  int Set(const char *paramName, int paramValue);

  int Set(const char *paramName, float paramValue);

  int Set(const char *paramName, double paramValue);

  int Set(const char *paramName, const char *paramValue);

  int ValChar(const char *paramName, char *paramValue);

  int ValInt(const char *paramName, int *paramValue);

  int ValFloat(const char *paramName, float *paramValue);

  int ValDouble(const char *paramName, double *paramValue);

  int ValString(const char *paramName, char *paramValue);

  void ClrAcqList(int instance);

  void ClrCtrlList(int instance);

  int Load(char **paramBuf, size_t size, char *erms);

  int Load(const char *paramBuf, char *erms);

  int Load(const char *fileName, const char *mask, char *erms);

  void Options(int argc, char *argv[]);

  void Print(FILE *s = NULL);

  void Print(char *s);
 
protected:
 
private:
  ngcbPARAM_LIST *first_;

  ngcbPARAM_LIST *current_;

  int noDelete_;

  int Load_(const char *fileName, const char *mask, int *inclLevel, 
        char *erms);
};
 
 
#endif