cinosadcchannel.h

Go to the documentation of this file.

//******************************************************************************
//******************************************************************************
 
#ifndef INC_CINOSADCCHANNEL_H
#define INC_CINOSADCCHANNEL_H
 
//------------------------------------------------------------------------------
// defines
//------------------------------------------------------------------------------
//
//
//------------------------------------------------------------------------------
// includes
//------------------------------------------------------------------------------
//
// system
#include <cinosprocessimage.h>
//
// C++
//
// project
//
//------------------------------------------------------------------------------
// class definition
//------------------------------------------------------------------------------
//
class CINOSAdcChannel : public CINOSProcessImageValue
{
    //--- user interface ---------------------------------------------------
 
    // public member functions
    public :
        ICACHE virtual void Set(real64 arValue) override;
            //; set channel to arValue
        ICACHE virtual real64 Get() override;
            //; get value of channel
        ICACHE real32 GetValue();
            //; return actual channel value (mV, °C, ...) [real32]
        #if defined(INOS_PROCESSIMAGE_OVERWRITE)
        ICACHE void SetValue(real32 arValue, bool abOverwrite = true);
            //; set channel to arValue
            //; (abOverwrite=true -> value always set, abOverwrite=false -> value
            //; set if channel is NOT in overwrite mode)
        #else
        ICACHE void SetValue(real32 arValue);
            //; set channel to arValue
        #endif
        real32 GetRawValue(uint32 auStage=0);
            //; return raw value before hook number 'auStage'
        void SetRange(uint8 auRange);
            //; set channel range
        uint8 GetRange();
            //; get channel range
 
    //--- internals --------------------------------------------------------
 
    // constructor / destructor
    public:
        CINOSAdcChannel (const char* apName, uint16 auNumber,   char* apUnit="mV",
            uint16 auCharacteristics=defCharShowFix + SHOW_DIGIT(3),
            real64 arLower=REAL64(-10500.0),
            real64 arUpper=REAL64(+10500.0),
            uint16 auType=defType_real32, uint16 auArrayLength=1,
            const char* apComboListData=0   // "key0;text0;key1;text1;...": if given
                // (together with auType==defType_uint32), the channel is
                // registered as an enum combo (see CreateINCOEnumCombo())
                // instead of a plain number
            );
        void SetupChannel (uint16 auNumber, char* apUnit, uint16 auCharacteristics,
            real64 arLower, real64 arUpper, uint16 auType, uint16 auArrayLength,
            const char* apComboListData=0 );
        void ConvertToReal (uint16 auNumber, char* apUnit, uint16 auCharacteristics,
            real64 arLower, real64 arUpper, uint16 auType, uint16 auArrayLength );
};
 
//
//------------------------------------------------------------------------------
// class CINCOProcessImageAdc
//------------------------------------------------------------------------------
 
class CINCOProcessImageAdc : public CINCOreal32
{
    // constructor
    public:
        CINCOProcessImageAdc(const char* apName, uint16 auNumber, real32 arLower, 
            real32 arUpper, char* apUnit, uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex, long aOffset) override;
        virtual long Put(void* aSource, long aIndex, long aOffset) override;
        virtual long GetProperty(void* aDest, char* aName, long aIndex=0,
            long aOffset=0, long* apMaxLength=0, CINCOObject* apParent=0) override;
 
        virtual long GetType() override;
 
        virtual uint64 GetCharacteristics() override;
 
    // protected members
    protected :
        uint16 m_uNumber;
        uint32 m_uForeColor;
            
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageAdc);
};
 
//------------------------------------------------------------------------------
// class CINCOProcessImageAdc_int32
//------------------------------------------------------------------------------
 
class CINCOProcessImageAdc_int32 : public CINCOint32
{
    // constructor
    public:
        CINCOProcessImageAdc_int32(const char* apName, uint16 auNumber, int32 aiLower, 
            int32 aiUpper, char* apUnit, uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex, long aOffset) override;
        virtual long Put(void* aSource, long aIndex, long aOffset) override;
 
    // protected members
    protected :
        uint16 m_uNumber;
        uint32 m_uForeColor;
            
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageAdc_int32);
};
 
//------------------------------------------------------------------------------
// class CINCOProcessImageAdc_uint32
//------------------------------------------------------------------------------
 
class CINCOProcessImageAdc_uint32 : public CINCOuint32
{
    // constructor
    public:
        CINCOProcessImageAdc_uint32(const char* apName, uint16 auNumber, uint32 auLower,
            uint32 auUpper, char* apUnit, uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex, long aOffset) override;
        virtual long Put(void* aSource, long aIndex, long aOffset) override;
 
    // protected members
    protected :
        uint16 m_uNumber;
        uint32 m_uForeColor;
            
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageAdc_uint32);
};
 
//------------------------------------------------------------------------------
// class CINCOProcessImageAdc_combo
//------------------------------------------------------------------------------
//
// Same as CINCOProcessImageAdc_uint32, but displays the raw channel value as
// an enum combo (see CreateINCOEnumCombo()) instead of a plain number - e.g.
// for an IODD SimpleDatatype with SingleValue enumerations, where each raw
// value (0, 1, 2, ...) has a corresponding text (e.g. 0 -> "Off", 1 -> "On").
 
class CINCOProcessImageAdc_combo : public CINCOuint32combo
{
    // constructor
    public:
        CINCOProcessImageAdc_combo(const char* apName, uint16 auNumber,
            const char* apComboListData, uint32 auLower, uint32 auUpper, char* apUnit,
            uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex, long aOffset) override;
        virtual long Put(void* aSource, long aIndex, long aOffset) override;
 
    // protected members
    protected :
        uint16 m_uNumber;
        uint32 m_uForeColor;
 
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageAdc_combo);
};
 
//------------------------------------------------------------------------------
// class CINCOProcessImageAdc_real64
//------------------------------------------------------------------------------
 
class CINCOProcessImageAdc_real64 : public CINCOreal64
{
    // constructor
    public:
        CINCOProcessImageAdc_real64(const char* apName, uint16 auNumber, real64 arLower,
            real64 arUpper, char* apUnit, uint16 auCharacteristics);
 
    // public member functions
    public:
        virtual long Get(void* aDest, long& maxLength, long aIndex, long aOffset) override;
        virtual long Put(void* aSource, long aIndex, long aOffset) override;
 
    // protected members
    protected :
        uint16 m_uNumber;
        uint32 m_uForeColor;
 
    // allow dynamic object handling (new/delete)
    DECLARE_DYNAMIC(CINCOProcessImageAdc_real64);
};
 
//------------------------------------------------------------------------------
// end of file
//------------------------------------------------------------------------------
 
#endif  // INC_CINOSADCCHANNEL_H