cinosadcchannels.h

Go to the documentation of this file.

//******************************************************************************
//******************************************************************************
 
#ifndef INC_CINOSADCCHANNELS_H
#define INC_CINOSADCCHANNELS_H
 
//------------------------------------------------------------------------------
// defines
//------------------------------------------------------------------------------
//
#define DF_INOS_IMAGE_ANALOG_INPUTS_NUMBER  DF_INOS_PROCESSIMAGE_ANALOG_INPUTS_NUMBER   // def. number of ana inputs
//
#define DF_INOS_ADC_RANGE_BIP_10000mV       0   // adc range number +-10000 mV
#define DF_INOS_ADC_RANGE_BIP_1000mV        1   // adc range number +-1000 mV
#define DF_INOS_ADC_RANGE_BIP_100mV         2   // adc range number +-100 mV
#define DF_INOS_ADC_RANGE_BIP_10mV          3   // adc range number +-10 mV
#define DF_INOS_ADC_RANGE_UNI_10000mV       4   // adc range number 0..+10000 mV
#define DF_INOS_ADC_RANGE_UNI_1000mV        5   // adc range number 0..+1000 mV
#define DF_INOS_ADC_RANGE_UNI_100mV         6   // adc range number 0..+100 mV
#define DF_INOS_ADC_RANGE_UNI_10mV          7   // adc range number 0..+10 mV
//
#define DF_INOS_ADC_RANGE_BIP_5000mV        8   // adc range number +-5000 mV
#define DF_INOS_ADC_RANGE_BIP_500mV         9   // adc range number +-500 mV
#define DF_INOS_ADC_RANGE_BIP_50mV          10  // adc range number +-50 mV
#define DF_INOS_ADC_RANGE_BIP_5mV           11  // adc range number +-5 mV
#define DF_INOS_ADC_RANGE_UNI_5000mV        12  // adc range number 0..+5000 mV
#define DF_INOS_ADC_RANGE_UNI_500mV         13  // adc range number 0..+500 mV
#define DF_INOS_ADC_RANGE_UNI_50mV          14  // adc range number 0..+50 mV
#define DF_INOS_ADC_RANGE_UNI_5mV           15  // adc range number 0..+5 mV
//
#define DF_INOS_ADC_RANGE_UNI_20mA          32  // adc range number 0..+20mA
#define DF_INOS_ADC_RANGE_BIP_5000mA        40  // adc range number +-5000 mA
 
#define DF_INOS_ADC_RANGE_BIP_48000mV       128 // adc range number +-48000 mV
 
#define DF_INOS_ADC_RANGE_DISABLED          255 // adc disabled
//
//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
//
// system
//
// C++
//
// project
//
//------------------------------------------------------------------------------
// class definition
//------------------------------------------------------------------------------
//
class CINOSAdcChannels : public CINOSProcessImageValues
{
    //--- user interface ---------------------------------------------------
 
    // public member functions
    public :
        ICACHE virtual void Set(uint16 auNumber, real64 arValue) override;
            //; set channel 'auNumber' to arValue
        ICACHE virtual real64 Get(uint16 auNumber) override;
            //; get value of channel 'auNumber'
        ICACHE real32 GetValue(uint16 auNumber);
            //; return value of channel auNumber (mV, °C, ...) [real32]
        #if defined(INOS_PROCESSIMAGE_OVERWRITE)
        ICACHE void SetValue(uint16 auNumber, real32 afValue, bool abOverwrite = true);
            //; set value of channel auNumber to afValue
            //; (abOverwrite=true -> value always set, abOverwrite=false -> value
            //; set if channel is NOT in overwrite mode)
        #else
        ICACHE void SetValue(uint16 auNumber, real32 afValue);
            //; set value of channel auNumber to afValue
        #endif
        real32 GetRawValue(uint16 auNumber, uint32 auStage=0);
            //; return raw value of channel auNumber before hook number 'auStage'
        CINOSAdcChannel* Find(const char* apName,
            uint32 auSimulate = DF_INOS_IMAGE_CHN_SIM_DEF);
            //; return pointer to channel with apName or NULL if not found
        CINOSAdcChannel* Find(uint16 auNumber,
            uint32 auSimulate = DF_INOS_IMAGE_CHN_SIM_DEF);
            //; return pointer to channel with auNumber or NULL if not found
        void SetRange(uint16 auNumber, uint8 auRange);
            //; set channel range
        uint8 GetRange(uint16 auNumber);
            //; get channel range
 
        CINOSAdcChannel* CreateVirtual(const char* apName,
            uint16 auType   = defType_double,
            real64 arLower  = REAL64MIN,
            real64 arUpper  = REAL64MAX,
            char* apUnit    = nullptr,
            uint16 auCharacteristics = defCharShowFix + SHOW_DIGIT(4)
        );
            //; creates a new ADC channel that does not directly translate to hardware
            //; useful to add custom channels to the process image
 
    //--- internals --------------------------------------------------------
 
    // constructor / destructor
    public :
        CINOSAdcChannels (char* apName, uint32 auNumber, void* apImage);
            //; object constructor
 
    // public member functions but just for internal use
    public:
        static void Create();
            //; check if process image already exists, if no create one
};
 
//
//------------------------------------------------------------------------------
// global variables
//------------------------------------------------------------------------------
//
#define g_pAdcChannels ((CINOSAdcChannels *) g_pImage[DF_PROCESS_IMAGE_ANALOG_INPUTS])
//
//------------------------------------------------------------------------------
// end of file
//------------------------------------------------------------------------------
 
#endif  // INC_CINOSADCCHANNELS_H