FiDeviceFunctionFactory.H

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2023 SAP SE
//
// SPDX-License-Identifier: Apache-2.0
//
// This file is part of FEDEM - https://openfedem.org
 
#ifndef FI_DEVICE_FUNCTION_FACTORY_H
#define FI_DEVICE_FUNCTION_FACTORY_H
 
#include "FFaLib/FFaPatterns/FFaSingelton.H"
#include "FFaLib/FFaOS/FFaIO.H"
#include <string>
#include <vector>
#include <map>
 
class FiDeviceFunctionBase;
 
 
enum FiStatus {
  IO_READ  = 1, 
  IO_WRITE = 2  
};
 
enum FiDevFormat {
  NON_EXISTING = -1, 
  UNKNOWN_FILE =  0, 
  DAC_FILE,    
  ASC_FILE,    
  ASC_MC_FILE, 
  RPC_TH_FILE, 
  EXT_FUNC     
};
 
 
class FiDeviceFunctionFactory : public FFaSingelton<FiDeviceFunctionFactory>
{
protected:
  FiDeviceFunctionFactory() : myExtFnFile(0) { myNumExtFun = 0; }
  virtual ~FiDeviceFunctionFactory();
 
public:
  int open(const std::string& fileName, FiDevFormat format = UNKNOWN_FILE,
           FiStatus status = IO_READ, int inputChannel = 0,
           bool littleEndian = false);
 
  void close(const std::string& fileName);
  void close(int fileIndex);
 
  double getValue(int fileIndex, double arg, int& stat, int channel = 0,
                  int zeroAd = 0, double shift = 0.0, double scale = 1.0) const;
  bool getValues(int fileIndex, double x0, double x1,
                 std::vector<double>& x, std::vector<double>& y,
                 int channel = 0, int zeroAdjust = 0,
                 double shift = 0.0, double scale = 1.0) const;
 
  double getStep(int fileIndex) const;
  double getFrequency(int fileIndex) const;
 
  void getAxisTitle(int fileIndex, int axis, char* axisText, size_t n) const;
  void getAxisUnit(int fileIndex, int axis, char* unitText, size_t n) const;
 
  bool setValue(int fileIndex, double xVal, double yVal);
 
  void setStep(int fileIndex, double step) const;
  void setFrequency(int fileIndex, double freq) const;
 
  void setAxisTitle(int fileIndex, int axis, const char* axisText) const;
  void setAxisUnit(int fileIndex, int axis, const char* unitText) const;
 
  int channelIndex(int fileIndex, const std::string& channel) const;
  bool getChannelList(int fileIndex, std::vector<std::string>& ch) const;
 
  static bool getChannelList(const std::string& fileName,
                             std::vector<std::string>& channels);
 
  static FiDevFormat identify(const std::string& fileName,
                              const std::string& path = "",
                              FiStatus status = IO_READ);
 
  void dump() const;
 
  bool initExtFuncFromFile(const std::string& fileName,
                           const std::string& labels = "");
  bool updateExtFuncFromFile(int nstep = 1);
  double getExtFunc(int idx, int stat = 0) const
  {
    return this->getValue(0,0.0,stat,idx);
  }
 
  void storeExtFuncValues(double* data, unsigned int ndat, int iop, int& offs);
 
protected:
  int create(const std::string& fileName, int inputChannel,
             FiDevFormat format, FiStatus status, bool useLittleEndian);
 
  FiDeviceFunctionBase* getDevice(size_t fileIndex) const;
 
public:
  static int myNumExtFun; 
 
private:
  typedef std::map<std::string,size_t> FileMap;
  typedef std::pair<std::string,int>   FileChannel;
  typedef std::map<FileChannel,size_t> FileChnMap;
 
  std::vector<FiDeviceFunctionBase*> myDevices; 
 
  FileMap    myFileToIndexMap; 
  FileChnMap myFileChannelMap; 
 
  std::vector<double> myExtValues; 
  std::vector<int>    myExtIndex;  
  FT_FILE             myExtFnFile; 
 
  friend class FFaSingelton<FiDeviceFunctionFactory>;
};
 
#endif